SAP ABAP Interface IF_FOX3_FLOB_SELECTOR (Information Retrieval for FOX File)

Hierarchy

☛ SAP_BS_FND (Software Component) SAP Business Suite Foundation
   ⤷ CA-MDG-DRF (Application Component) Data Replication Framework
     ⤷ FOX3 (Package) Framework for hierarchy explosion

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	CL_FOX3_FLOB_DB_SELECTOR	Database Access to FOX File	20100514
2	Interface implementation (CLASS c. INTERFACES i_ref)	CL_FOX3_FLOB_MEMORY_SELECTOR	Memory Accesses for a FOX File	20100514

Properties

Interface	IF_FOX3_FLOB_SELECTOR
Short Description	Information Retrieval for FOX File

General Data

Package	FOX3	Framework for hierarchy explosion
Created	20100514	SAP
Last changed	20110908	SAP
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	CFOX3	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_FOX3_FREEABLE_OBJECT	☐	☐	ObjeCt with Free_Data Method	20100514

Friends

Interface IF_FOX3_FLOB_SELECTOR has no friend.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GS_TOP_OBJECT	Instance attribute	Public	☑	Type reference (TYPE)	FOX3_LINKED_KEY_EXT_S		Object Type, Key, and Link Color	20100514
2	GV_DIRECTION	Instance attribute	Public	☑	Type reference (TYPE)	FOX3_EXPL_DIRECTION		Direction of Explosion	20100514
3	GV_FREED	Instance attribute	Public	☐	Attribute reference (LIKE)				20100514
4	GV_SINGLE_TOP	Instance attribute	Public	☑	Type reference (TYPE)	FLAG_X		Only One Top Object	20100514
5	GV_SOURCE	Instance attribute	Public	☑	Type reference (TYPE)	FOX3_DATA_SOURCE		Type of Data Source	20100514
6	GV_WHOLE_FLOB	Instance attribute	Public	☑	Type reference (TYPE)	FLAG_X		Read the entire FLOB?	20100514

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	FIND_OBJECT	Instance method	Public	Method	Find Object	20100514
2	FREE_DATA	Instance method	Public	Method		20100514
3	GET_NUMBER_BY_TYPE	Instance method	Public	Method	Stage Object Type and Number of Objects	20100514
4	GET_OBJECTS_BY_TYPE	Instance method	Public	Method	Stage All Objects for Type	20100514
5	GET_OBJECTS_TO_PARENT	Instance method	Public	Method	Stage All Subordinate Objects	20100514
6	GET_PARENTS_TO_OBJECT	Instance method	Public	Method	Stage All Superior Objects	20100514
7	GET_STATISTIC	Instance method	Public	Method	Statistical Information for an Explosion	20100514
8	GET_TOP_OBJECTS	Instance method	Public	Method	Stage Top Objects	20100514
9	GET_TOTAL_STATISTIC	Instance method	Public	Method	Statistical Information for the Entire FLOB	20100514
10	GET_VALIDITIES	Instance method	Public	Method	Stage Validities	20100514
11	IS_TOP_OBJECT	Instance method	Public	Method	Is the Object a Top Object?	20100514
12	SET_DIRECTION	Instance method	Public	Method	Determine Direction of Explosion	20100514
13	SET_FOCUS	Instance method	Public	Method	Set Entire FLOB or New Top Object	20100514
14	UPDATE_DATA	Instance method	Public	Method	Refresh Data	20100514
15	WHERE_USED	Instance method	Public	Method	Where-Used List for Top Objects	20100514
16	WRITE_HIERARCHIE_AS_LIST	Instance method	Public	Method	Output Hierarchy as List	20100514

Events

Interface IF_FOX3_FLOB_SELECTOR has no event.

Types

Interface IF_FOX3_FLOB_SELECTOR has no local type.

Method Signatures

Method FIND_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_LINKED_OBJECT	Call by reference	☐	Type reference (TYPE)	FOX3_LINKED_KEY_EXT_T		Object Type, Key (Also External) and Link Color	20100514
2	Importing	IS_LINKED_OBJECT	Call by reference	☐	Type reference (TYPE)	FOX3_LINKED_KEY_S		Object Type, Key, and Link Color	20100514
3	Importing	IV_IGNORE_LINK_TYPE	Call by reference	☐	Type reference (TYPE)	FOX3_IGNORE_LINK_TYPE		Ignore Link Type	20100514
4	Importing	IV_USE_ALL_EXPLOSIONS	Call by reference	☐	Type reference (TYPE)	FLAG_X		Include All Explosions	20100514

#	Exception	Resumable	Description	Created on
1	OBJECT_NOT_FOUND	☐	Object Not Found	20100514

Method FREE_DATA Signature

Method FREE_DATA on Interface IF_FOX3_FLOB_SELECTOR has no parameter.
Method FREE_DATA on Interface IF_FOX3_FLOB_SELECTOR has no exception.

Method GET_NUMBER_BY_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_NUM_TYPE	Call by reference	☐	Type reference (TYPE)	FOX3_NUM_OBJ_TYPE_T		Object Type and Number	20100514

Method GET_NUMBER_BY_TYPE on Interface IF_FOX3_FLOB_SELECTOR has no exception.

Method GET_OBJECTS_BY_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_LINKED_OBJECT	Call by reference	☐	Type reference (TYPE)	FOX3_LINKED_KEY_EXT_T		Object Type, Key (Also External) and Link Color	20100514
2	Exporting	EV_NUM_OBJECT	Call by reference	☐	Type reference (TYPE)	I		Number of Objects	20100514
3	Importing	IV_IGNORE_LINK_TYPE	Call by reference	☐	Type reference (TYPE)	FOX3_IGNORE_LINK_TYPE		Ignore Link Type	20100514
4	Importing	IV_OBJ_TYPE	Call by reference	☐	Type reference (TYPE)	FOX3_OBJ_TYPE		Object Type (Such As Material or BOM)	20100514

Method GET_OBJECTS_BY_TYPE on Interface IF_FOX3_FLOB_SELECTOR has no exception.

Method GET_OBJECTS_TO_PARENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_PARENT_OBJECT	Call by reference	☐	Type reference (TYPE)	FOX3_PARENT_OBJECT_KEY_EXT_T		Parent Object Structure on Key Basis	20100514
2	Importing	IS_LINKED_PARENT	Call by reference	☐	Type reference (TYPE)	FOX3_LINKED_KEY_S		Object Type, Key, and Link Color	20100514
3	Importing	IV_IGNORE_LINK_TYPE	Call by reference	☐	Type reference (TYPE)	FOX3_IGNORE_LINK_TYPE		Ignore Link Type	20100514

#	Exception	Resumable	Description	Created on
1	INCOMPLETE_FLOB	☐	Inconsistent Explosion	20100514
2	OBJECT_NOT_FOUND	☐	Object Not Found	20100514

Method GET_PARENTS_TO_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_OBJECT_PARENT	Call by reference	☐	Type reference (TYPE)	FOX3_OBJECT_PARENT_KEY_EXT_T		Object Parent Structure on Key Basis	20100514
2	Importing	IS_LINKED_OBJECT	Call by reference	☐	Type reference (TYPE)	FOX3_LINKED_KEY_S		Object Type, Key, and Link Color	20100514
3	Importing	IV_IGNORE_LINK_TYPE	Call by reference	☐	Type reference (TYPE)	FOX3_IGNORE_LINK_TYPE		Ignore Link Type	20100514

#	Exception	Resumable	Description	Created on
1	INCOMPLETE_FLOB	☐	Inconsistent Explosion	20100514
2	OBJECT_NOT_FOUND	☐	Object Not Found	20100514

Method GET_STATISTIC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_NUM_INSTANCE	Call by reference	☐	Type reference (TYPE)	FOX3_NUM_INSTANCE		Number of Instances	20100514
2	Exporting	EV_NUM_STRUCTURE	Call by reference	☐	Type reference (TYPE)	FOX3_NUM_STRUCTURE		Number of Object Relationships	20100514

Method GET_STATISTIC on Interface IF_FOX3_FLOB_SELECTOR has no exception.

Method GET_TOP_OBJECTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_TOP_OBJECT	Call by reference	☐	Type reference (TYPE)	FOX3_LINKED_KEY_EXT_T		Object Type, Key, and Link Color	20100514
2	Exporting	EV_NUM_TOP_OBJECT	Call by reference	☐	Type reference (TYPE)	I		Number of Top-Level Objects	20100514

Method GET_TOP_OBJECTS on Interface IF_FOX3_FLOB_SELECTOR has no exception.

Method GET_TOTAL_STATISTIC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_SUM_INSTANCE	Call by reference	☐	Type reference (TYPE)	I		Total Number of Objects	20100514
2	Exporting	EV_SUM_STRUCTURE	Call by reference	☐	Type reference (TYPE)	I		Number of All Structure Records	20100514

Method GET_TOTAL_STATISTIC on Interface IF_FOX3_FLOB_SELECTOR has no exception.

Method GET_VALIDITIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EI_VALIDITY	Call by reference	☐	Object reference (TYPE REF TO)	IF_FOX3_OBJECT_VALIDITY		Object Validity	20100514
2	Exporting	ES_VALIDITY	Call by reference	☐	Type reference (TYPE)	FOX3_OBJECT_VALIDITY_S		Validity Attributes for Object	20100514
3	Importing	IS_OBJECT_KEY	Call by reference	☐	Type reference (TYPE)	FOX3_OBJECT_KEY_S		Generic Object Key for Factory	20100514
4	Importing	IV_USE_ALL_EXPLOSIONS	Call by reference	☐	Type reference (TYPE)	FLAG_X		Include All Explosions	20100514

#	Exception	Resumable	Description	Created on
1	OBJECT_NOT_FOUND	☐	Object Not Found	20100514

Method IS_TOP_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_LINKED_KEY_EXT	Call by reference	☐	Type reference (TYPE)	FOX3_LINKED_KEY_EXT_S		Object Type, Key (Also External) and Link Color	20100514
2	Exporting	EV_FLAG	Value transfer	☐	Type reference (TYPE)	FLAG_X		Indicator	20100514
3	Importing	IS_LINKED_KEY	Call by reference	☐	Type reference (TYPE)	FOX3_LINKED_KEY_S		Object Type, Key, and Link Color	20100514

Method IS_TOP_OBJECT on Interface IF_FOX3_FLOB_SELECTOR has no exception.

Method SET_DIRECTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_DIRECTION	Call by reference	☐	Type reference (TYPE)	FOX3_EXPL_DIRECTION		Direction of Explosion	20100514

Method SET_DIRECTION on Interface IF_FOX3_FLOB_SELECTOR has no exception.

Method SET_FOCUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_LINKED_KEY	Call by reference	☑	Type reference (TYPE)	FOX3_LINKED_KEY_S		Object Type, Key, and Link Color	20100514
2	Importing	IV_WHOLE_FLOB	Call by reference	☑	Type reference (TYPE)	FLAG_X		Indicator	20100514

#	Exception	Resumable	Description	Created on
1	OBJECT_IS_NOT_TOP	☐	Object Is Not a Top-Level Object	20100514
2	UNCHANGED	☐	Focus Was Not Changed	20100514

Method UPDATE_DATA Signature

Method UPDATE_DATA on Interface IF_FOX3_FLOB_SELECTOR has no parameter.
Method UPDATE_DATA on Interface IF_FOX3_FLOB_SELECTOR has no exception.

Method WHERE_USED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_TOPOBJECT_OBJECT	Call by reference	☐	Type reference (TYPE)	FOX3_PARENT_OBJECT_KEY_EXT_T		Parent Object Structure on Key Basis	20100514
2	Exporting	EV_NUM_TOP_OBJECT	Call by reference	☐	Type reference (TYPE)	I		Number of Top Objects	20100514
3	Importing	IS_LINKED_OBJECT	Call by reference	☐	Type reference (TYPE)	FOX3_LINKED_KEY_S		Object Type, Key, and Link Color	20100514
4	Importing	IV_IGNORE_LINK_TYPE	Call by reference	☐	Type reference (TYPE)	FOX3_IGNORE_LINK_TYPE		Ignore Link Type	20100514

#	Exception	Resumable	Description	Created on
1	OBJECT_NOT_FOUND	☐	Object Not Found	20100514

Method WRITE_HIERARCHIE_AS_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_UI_OPTIONS	Call by reference	☐	Type reference (TYPE)	FOX3_UI_OPTIONS_S		Interface Options	20100514
2	Importing	IV_SORTED	Call by reference	☐	Type reference (TYPE)	FLAG_X		Sorted by Type and Key	20100514

#	Exception	Resumable	Description	Created on
1	INVALID_REFERENCE	☐	Invalid Reference	20100514
2	TOP_OBJECT_NOT_SPECIFIED	☐	No Top Object Selected	20100514

History

Last changed by/on	SAP	20110908
SAP Release Created in