SAP ABAP Interface IF_SRM_CONT_ELEMENT_COLLECT (Collection by Container Elements)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-RM (Application Component) SAP Records Management
     ⤷ SRM_CONTAINER_ELEMENT (Package) Element(s) of a Container

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	CL_SRM_CONT_ELEMENT_COLLECT	Collection by Container Elements	20031106

Properties

Interface	IF_SRM_CONT_ELEMENT_COLLECT
Short Description	Collection by Container Elements

General Data

Package	SRM_CONTAINER_ELEMENT	Element(s) of a Container
Created	20031103	SAP
Last changed	20050214	SAP
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	IF_SRM	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_SRM_CONT_ELEMENT_COLLECT_XT	☐	☐	Collection via Container Elements: Enhancements	20050118

Friends

Interface IF_SRM_CONT_ELEMENT_COLLECT has no friend.

Attributes

Interface IF_SRM_CONT_ELEMENT_COLLECT has no attribute.

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_ELEMENT	Instance method	Public	Method	Add an Element to the Collection	20031110
2	ADD_ELEMENTS	Instance method	Public	Method	Add Two or More Elements to the Collection	20031110
3	CREATE_ITERATOR	Instance method	Public	Method	Create/Return Iterator for Collection	20031106
4	DELETE_ELEMENT	Instance method	Public	Method	Delete Element from Collection	20040219
5	DELETE_ELEMENT_BY_POS	Instance method	Public	Method	Delete Element from Collection (Using Position)	20040216
6	GET_DIRECT_CHILDS_OF_ELEMENT	Instance method	Public	Method	Find Direct Children of an Element	20041008
7	GET_ELEMENT	Instance method	Public	Method	Return Element (Using Index)	20031106
8	GET_ELEMENTS	Instance method	Public	Method	Return All Elements in the Collection	20031111
9	GET_ELEMENT_BY_ID	Instance method	Public	Method	Return Element (Using ID)	20041008
10	GET_ID_OF_ROOT_CONTAINER	Instance method	Public	Method	Find Container ID	20041008
11	GET_INDEX_OF_ELEMENT	Instance method	Public	Method	Return Index of an Element	20041130
12	GET_NUMBER_OF_ELEMENTS	Instance method	Public	Method	Return Number of Elements in the Collection	20040113
13	HAS_ELEMENT_CHILDREN	Instance method	Public	Method	Returns if an element in the collection has children	20040220
14	IS_ELEMENT_EXISTING	Instance method	Public	Method	Checks if an element exists in the collection	20040305
15	IS_POID_EXISTING	Instance method	Public	Method	Checks if an element with the specified POID exists	20050117
16	SEARCH_ELEMENT_BY_DESCRIPTION	Instance method	Public	Method	Searches for an Element (Description)	20041015

Events

Interface IF_SRM_CONT_ELEMENT_COLLECT has no event.

Types

Interface IF_SRM_CONT_ELEMENT_COLLECT has no local type.

Method Signatures

Method ADD_ELEMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_ELEMENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_SRM_CONTAINER_ELEMENT		Element	20031110
2	Importing	IM_POS	Call by reference	☐	Type reference (TYPE)	I	0	Position(Index) innerhalb der Collect, 0 = am Ende	20040121

#	Exception	Resumable	Description	Created on
1	CX_SRM_CONT_ELEMENT_COLLECTION	☐	Fehlerklasse für Element-Collection/Iterator	20040121

Method ADD_ELEMENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_ELEMENT_TAB	Call by reference	☐	Type reference (TYPE)	SRMRI_CONT_ELEM_4_COLLECT_TAB		Elemente	20031110
2	Importing	IM_POS	Call by reference	☐	Type reference (TYPE)	I	0	Pos Einfügen, 0 = am Ende	20040121

#	Exception	Resumable	Description	Created on
1	CX_SRM_CONT_ELEMENT_COLLECTION	☐	Fehlerklasse für Element-Collection/Iterator	20040121

Method CREATE_ITERATOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_ITERATOR	Value transfer	☐	Object reference (TYPE REF TO)	IF_SRM_CONT_ELEMENT_ITERATOR		Iterator	20031106

Method CREATE_ITERATOR on Interface IF_SRM_CONT_ELEMENT_COLLECT has no exception.

Method DELETE_ELEMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_DELETE_CHILDS	Call by reference	☐	Type reference (TYPE)	SRMBOOLEAN	IF_SRM=>TRUE	Kinder auch löschen	20041215
2	Importing	IM_ELEMENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_SRM_CONTAINER_ELEMENT		Element in einem Container(Akte etc.)	20040219

Method DELETE_ELEMENT on Interface IF_SRM_CONT_ELEMENT_COLLECT has no exception.

Method DELETE_ELEMENT_BY_POS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_DELETE_CHILDS	Call by reference	☐	Type reference (TYPE)	SRMBOOLEAN	IF_SRM=>TRUE	Boolean: Mögliche Werte IF_SRM=>TRUE / FALSE	20040225
2	Importing	IM_POSITION	Call by reference	☐	Type reference (TYPE)	I		Position	20040216

Method DELETE_ELEMENT_BY_POS on Interface IF_SRM_CONT_ELEMENT_COLLECT has no exception.

Method GET_DIRECT_CHILDS_OF_ELEMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_CONTAINER_ID	Call by reference	☐	Type reference (TYPE)	STRING		Container-ID	20041008
2	Importing	IM_PARENT_ID	Call by reference	☐	Type reference (TYPE)	STRING		Eltern-ID	20041008
3	Returning	RE_ELEMENT_TAB	Value transfer	☐	Type reference (TYPE)	SRMRI_CONT_ELEM_4_COLLECT_TAB		Collection über Container-Elemente	20041008

#	Exception	Resumable	Description	Created on
1	CX_SRM_CONT_ELEMENT_COLLECTION	☐	Fehlerklasse für Element-Collection/Iterator	20041008

Method GET_ELEMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_INDEX	Call by reference	☐	Type reference (TYPE)	I		Index	20031106
2	Returning	RE_ELEMENT	Value transfer	☐	Object reference (TYPE REF TO)	IF_SRM_CONTAINER_ELEMENT		Element	20031106

#	Exception	Resumable	Description	Created on
1	CX_SRM_CONT_ELEMENT_COLLECTION	☐	Elemente eines Containers	20040223

Method GET_ELEMENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_CONTAINER_ID	Call by reference	☑	Type reference (TYPE)	STRING		Container ID	20041008
2	Returning	RE_ELEMENT_TAB	Value transfer	☐	Type reference (TYPE)	SRMRI_CONT_ELEM_4_COLLECT_TAB		Elemente	20031111

Method GET_ELEMENTS on Interface IF_SRM_CONT_ELEMENT_COLLECT has no exception.

Method GET_ELEMENT_BY_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_CONTAINER_ID	Call by reference	☐	Type reference (TYPE)	STRING		ID des Containers	20041008
2	Importing	IM_ELEMENT_ID	Call by reference	☐	Type reference (TYPE)	STRING		Element-ID	20041008
3	Returning	RE_ELEMENT	Value transfer	☐	Object reference (TYPE REF TO)	IF_SRM_CONTAINER_ELEMENT		Element in einem Container(Akte etc.)	20041008

#	Exception	Resumable	Description	Created on
1	CX_SRM_CONT_ELEMENT_COLLECTION	☐	Fehlerklasse für Element-Collection/Iterator	20041008

Method GET_ID_OF_ROOT_CONTAINER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_ID	Value transfer	☐	Type reference (TYPE)	STRING		Container-ID	20041008

Method GET_ID_OF_ROOT_CONTAINER on Interface IF_SRM_CONT_ELEMENT_COLLECT has no exception.

Method GET_INDEX_OF_ELEMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_CONTAINER_ID	Call by reference	☐	Type reference (TYPE)	STRING		Container ID	20041130
2	Importing	IM_ELEMENT_ID	Call by reference	☐	Type reference (TYPE)	STRING		Element ID	20041130
3	Returning	RE_INDEX	Value transfer	☐	Type reference (TYPE)	I		Index des Elements in der Collection	20041130

#	Exception	Resumable	Description	Created on
1	CX_SRM_CONT_ELEMENT_COLLECTION	☐	Fehlerklasse für Element-Collection/Iterator	20041130

Method GET_NUMBER_OF_ELEMENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_NUMBER_OF_ELEMENTS	Value transfer	☐	Type reference (TYPE)	I		Anzahl Elemente	20040113

Method GET_NUMBER_OF_ELEMENTS on Interface IF_SRM_CONT_ELEMENT_COLLECT has no exception.

Method HAS_ELEMENT_CHILDREN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_ELEMENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_SRM_CONTAINER_ELEMENT		Element in einem Container(Akte etc.)	20040220
2	Returning	RE_HAS_CHILDS	Value transfer	☐	Type reference (TYPE)	SRMBOOLEAN		Boolean: Mögliche Werte IF_SRM=>TRUE / FALSE	20040220

Method HAS_ELEMENT_CHILDREN on Interface IF_SRM_CONT_ELEMENT_COLLECT has no exception.

Method IS_ELEMENT_EXISTING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_CONTAINER_ID	Call by reference	☐	Type reference (TYPE)	STRING		Container-ID	20040305
2	Importing	IM_ELEMENT_ID	Call by reference	☐	Type reference (TYPE)	STRING		Element-ID	20040305
3	Returning	RE_IS_EXISTING	Value transfer	☐	Type reference (TYPE)	SRMBOOLEAN		Boolean: Mögliche Werte IF_SRM=>TRUE / FALSE	20040305

Method IS_ELEMENT_EXISTING on Interface IF_SRM_CONT_ELEMENT_COLLECT has no exception.

Method IS_POID_EXISTING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_POID	Call by reference	☐	Object reference (TYPE REF TO)	IF_SRM_POID		Poid	20050117
2	Returning	RE_IS_EXISTING	Value transfer	☐	Type reference (TYPE)	SRMBOOLEAN		Boolean: Mögliche Werte IF_SRM=>TRUE / FALSE	20050117

Method IS_POID_EXISTING on Interface IF_SRM_CONT_ELEMENT_COLLECT has no exception.

Method SEARCH_ELEMENT_BY_DESCRIPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_REGEX_SEARCH_STR	Call by reference	☑	Type reference (TYPE)	STRING		Regulärer Ausdruck	20041015
2	Importing	IM_SIMPLE_SEARCH_STR	Call by reference	☑	Type reference (TYPE)	STRING		Einfacher Vergleich (performanter)	20041015
3	Importing	IM_STARTING_FROM_POS	Call by reference	☐	Type reference (TYPE)	I	1	Suche ab bestimmter Position beginnen	20041015
4	Returning	RE_ELEMENT	Value transfer	☐	Object reference (TYPE REF TO)	IF_SRM_CONTAINER_ELEMENT		falls Treffer: gefundenes Element	20041015

#	Exception	Resumable	Description	Created on
1	CX_SRM_CONT_ELEMENT_COLLECTION	☐	Fehlerklasse für Element-Collection/Iterator	20041015

History

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