SAP ABAP Interface IF_AXT_CATALOG_GEN_HELPER (Help access interface for catalog setup)

Hierarchy

☛ WEBCUIF (Software Component) SAP Web UI Framework
   ⤷ CA-GTF-EEW (Application Component) Easy Enhancement Workbench
     ⤷ AXT_COMMON (Package) Common Extensibility objects

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface composition (i COMPRISING i_ref)	IF_AXT_RULE_DIRECTOR_CALLBACK	Callback interface for rule director to extension	20090924
2	Interface implementation (CLASS c. INTERFACES i_ref)	CL_AXT_EXTENSION	Abstract extension handler	20080226
3	Interface implementation (CLASS c. INTERFACES i_ref)	CL_AXT_GENERATION_HELPER_TEST	Generation helper	20080415
4	Interface implementation (CLASS c. INTERFACES i_ref)	CL_AXT_UI_ELEMENT_FACTORY	UI Element Factory	20090306

Properties

Interface	IF_AXT_CATALOG_GEN_HELPER
Short Description	Help access interface for catalog setup

General Data

Package	AXT_COMMON	Common Extensibility objects
Created	20080214	SAP
Last changed	20110908	SAP
Unicode checks active	☑

Forward declarations

Interface IF_AXT_CATALOG_GEN_HELPER has no forward declaration.

Interfaces

Interface IF_AXT_CATALOG_GEN_HELPER has no interface.

Friends

Interface IF_AXT_CATALOG_GEN_HELPER has no friend.

Attributes

Interface IF_AXT_CATALOG_GEN_HELPER has no attribute.

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	FORCE_GUID	Instance method	Public	Method	Same as MAP_GUID but the GUID to use can be defined	20080624
2	GET_ACTIVE_ELEMENT	Instance method	Public	Method	Get an active element with a given GUID	20080603
3	GET_ELEMENT_NAME	Instance method	Public	Method	Get a name for an element	20080226
4	GET_EXT_HANDLER_VALUE	Instance method	Public	Method	Retrieves a parameter value from extension handler	20081127
5	GET_FIELD_NAME	Instance method	Public	Method	Get a name for a field	20080314
6	GET_LOGICAL_OBJECT_KEY	Instance method	Public	Method	Gets the key field for a logical object	20081030
7	GET_REFERENCE_OBJECT	Instance method	Public	Method	Get the name of a reference object	20080229
8	GET_REGISTRY_CONTEXT	Instance method	Public	Method	Retrieves a registry context	20080922
9	MAP_GUID	Instance method	Public	Method	Get a GUID for an element based on old GUID and refname	20080226
10	SET_REFERENCE_OBJECT	Instance method	Public	Method	Set the name of a reference object	20080304
11	SET_REGISTRY_CONTEXT	Instance method	Public	Method	Registers a registry context	20080922

Events

Interface IF_AXT_CATALOG_GEN_HELPER has no event.

Types

Interface IF_AXT_CATALOG_GEN_HELPER has no local type.

Method Signatures

Method FORCE_GUID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FORCED_GUID	Call by reference	☐	Type reference (TYPE)	AXT_GUID		GUID	20080624
2	Importing	IV_GUID	Call by reference	☐	Type reference (TYPE)	AXT_GUID		GUID	20080624
3	Importing	IV_GUID_REF	Call by reference	☐	Type reference (TYPE)	AXT_GUID_REF		GUID reference	20080624

#	Exception	Resumable	Description	Created on
1	CX_AXT_DATA_INVALID	☐	Data invalid error	20080624

Method GET_ACTIVE_ELEMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ELEMENT_GUID	Call by reference	☐	Type reference (TYPE)	AXT_GUID		GUID	20080603
2	Returning	RR_ELEMENT	Value transfer	☐	Object reference (TYPE REF TO)	IF_AXT_ELEMENT		General generation element	20080603

Method GET_ACTIVE_ELEMENT on Interface IF_AXT_CATALOG_GEN_HELPER has no exception.

Method GET_ELEMENT_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ELEMENT_GUID	Call by reference	☐	Type reference (TYPE)	AXT_GUID		GUID	20080226
2	Importing	IV_MUST_BE_FOUND	Call by reference	☑	Type reference (TYPE)	AXT_BOOLEAN		The element must be found in active catalog	20080306
3	Importing	IV_NO_CAT_OBJECT_NAME	Call by reference	☑	Type reference (TYPE)	AXT_BOOLEAN		The name is not used as object name for a catalog object	20081030
4	Importing	IV_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	AXT_OBJECT_TYPE		Object Type	20080226
5	Importing	IV_ONLY_CHECK	Call by reference	☑	Type reference (TYPE)	AXT_BOOLEAN		Don't fetch a new name, only check proposal	20100309
6	Importing	IV_PROPOSAL	Call by reference	☑	Type reference (TYPE)	AXT_NAME		Proposal for a name	20081014
7	Returning	RV_ELEMENT_NAME	Value transfer	☐	Type reference (TYPE)	AXT_NAME		Name	20080226

#	Exception	Resumable	Description	Created on
1	CX_AXT_DATA_NOT_FOUND	☐		20080310
2	CX_AXT_OPERATION_FAILED	☐		20080310

Method GET_EXT_HANDLER_VALUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_PARAMVALUE	Call by reference	☐	Type reference (TYPE)	AXT_PARAMVALUE		Parameter Value	20081127
2	Returning	RV_PARAMVALUE	Value transfer	☐	Type reference (TYPE)	AXT_PARAMVALUE		Parameter Value	20081127

#	Exception	Resumable	Description	Created on
1	CX_AXT_DATA_INVALID	☐	Data invalid error	20081127

Method GET_FIELD_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ELEMENT_GUID	Call by reference	☐	Type reference (TYPE)	AXT_GUID			20080314
2	Importing	IV_MUST_BE_FOUND	Call by reference	☑	Type reference (TYPE)	AXT_BOOLEAN			20080314
3	Returning	RV_ELEMENT_NAME	Value transfer	☐	Type reference (TYPE)	AXT_NAME			20080314

#	Exception	Resumable	Description	Created on
1	CX_AXT_DATA_NOT_FOUND	☐	Data not found error	20080314
2	CX_AXT_OPERATION_FAILED	☐	Operation error	20080314

Method GET_LOGICAL_OBJECT_KEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_FIELDNAME	Call by reference	☐	Type reference (TYPE)	FIELDNAME		Name of the key field	20081030
2	Exporting	EV_VALUE	Value transfer	☐	Type reference (TYPE)	STRING		Key value	20081030
3	Importing	IS_KEY_STRUCT	Call by reference	☑	Type reference (TYPE)	ANY		Structure with the key fields	20081030
4	Importing	IV_GUID	Call by reference	☐	Type reference (TYPE)	AXT_GUID		GUID	20081030
5	Importing	IV_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	AXT_OBJECT_TYPE		Object Type	20081030
6	Importing	IV_PROPOSAL	Call by reference	☑	Type reference (TYPE)	STRING			20090703
7	Importing	IV_TABNAME	Call by reference	☐	Type reference (TYPE)	TABNAME		Table Name	20081030

#	Exception	Resumable	Description	Created on
1	CX_AXT_OPERATION_FAILED	☐	Operation error	20081030

Method GET_REFERENCE_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_GUID_REF	Call by reference	☑	Type reference (TYPE)	AXT_GUID_REF		GUID reference	20080229
2	Importing	IV_OBJECT_REFNAME	Call by reference	☐	Type reference (TYPE)	AXT_PARAMETER		Parameter	20080229
3	Returning	RV_OBJECT_NAME	Value transfer	☐	Type reference (TYPE)	AXT_NAME		Name	20080229

#	Exception	Resumable	Description	Created on
1	CX_AXT_DATA_NOT_FOUND	☐	Data not found error	20080310

Method GET_REGISTRY_CONTEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_GUID_REF	Call by reference	☑	Type reference (TYPE)	AXT_GUID_REF			20090204
2	Importing	IV_NAME	Call by reference	☑	Type reference (TYPE)	AXT_CONTEXT		Enhancement Context	20080922
3	Returning	RR_CONTEXT	Value transfer	☐	Object reference (TYPE REF TO)	CL_AXT_REGISTRY_CONTEXT			20090204

#	Exception	Resumable	Description	Created on
1	CX_AXT_DATA_NOT_FOUND	☐		20090204
2	CX_AXT_OPERATION_FAILED	☐		20090204

Method MAP_GUID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_GUID	Call by reference	☐	Type reference (TYPE)	AXT_GUID		GUID	20080226
2	Importing	IV_GUID_REF	Call by reference	☐	Type reference (TYPE)	AXT_GUID_REF		GUID reference	20080226
3	Returning	RV_GUID	Value transfer	☐	Type reference (TYPE)	AXT_GUID		GUID	20080226

Method MAP_GUID on Interface IF_AXT_CATALOG_GEN_HELPER has no exception.

Method SET_REFERENCE_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_GUID_REF	Call by reference	☑	Type reference (TYPE)	AXT_GUID_REF		GUID reference	20080304
2	Importing	IV_OBJECT_NAME	Call by reference	☐	Type reference (TYPE)	AXT_NAME		Name	20080304
3	Importing	IV_OBJECT_REFNAME	Call by reference	☐	Type reference (TYPE)	AXT_PARAMETER		Parameter	20080304

#	Exception	Resumable	Description	Created on
1	CX_AXT_DATA_ALREADY_EXISTS	☐		20080310

Method SET_REGISTRY_CONTEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_CONTEXT	Call by reference	☐	Object reference (TYPE REF TO)	CL_AXT_REGISTRY_CONTEXT		Base class for reg. ctx, special contexts can be derived	20080922
2	Importing	IV_GUID_REF	Call by reference	☑	Type reference (TYPE)	AXT_GUID_REF		GUID Reference	20090204
3	Importing	IV_NAME	Call by reference	☐	Type reference (TYPE)	AXT_CONTEXT		Enhancement Context	20080922

#	Exception	Resumable	Description	Created on
1	CX_AXT_DATA_ALREADY_EXISTS	☐	Data already exists error	20080922

History

Last changed by/on	SAP	20110908
SAP Release Created in	700