SAP ABAP Interface IF_BCFG_KEY_CONTAINER (Container class to store a set of keys (see doc.))

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-CUS-TOL-API (Application Component) Business Configuration API (SAP-internal)
     ⤷ S_BCFG_API (Package) Business Configuration Support API

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	CL_BCFG_BCSET_KEY_CONTAINER	container impl based on BC sets	20101122
2	Interface implementation (CLASS c. INTERFACES i_ref)	CL_BCFG_KEY_BASE_DECORATOR	base class for decorators specializing the key container API	20120307

Properties

Interface	IF_BCFG_KEY_CONTAINER
Short Description	Container class to store a set of keys (see doc.)

General Data

Package	S_BCFG_API	Business Configuration Support API
Created	20101118	SAP
Last changed	20130531	SAP
Unicode checks active	☑

Forward declarations

Interface IF_BCFG_KEY_CONTAINER has no forward declaration.

Interfaces

Interface IF_BCFG_KEY_CONTAINER has no interface.

Friends

Interface IF_BCFG_KEY_CONTAINER has no friend.

Attributes

Interface IF_BCFG_KEY_CONTAINER has no attribute.

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD	Instance method	Public	Method	adds the keys of another key container	20101118
2	ADD_KEY	Instance method	Public	Method	adds a key entry (see doc.)	20101118
3	ADD_KEYS	Instance method	Public	Method	adds several keys (see ADD_KEY)	20101118
4	ADD_KEYS_BY_FIELDS	Instance method	Public	Method	untyped version of ADD_KEY (see doc.)	20101216
5	GET_KEYS	Instance method	Public	Method	returns all keys for a given table	20101118
6	GET_KEYS_AS_FIELDS	Instance method	Public	Method	untyped version of GET_KEYS	20101216
7	IS_EMPTY	Instance method	Public	Method	returns ABAP_TRUE if no keys are specified by this container	20101118
8	REMOVE_ALL	Instance method	Public	Method	clears the key container so that it becomes EMPTY	20101118
9	REMOVE_KEY	Instance method	Public	Method	removes a key	20101118
10	REMOVE_KEYS	Instance method	Public	Method	removes several keys	20110517
11	REMOVE_KEYS_BY_FIELDS	Instance method	Public	Method	untyped version of REMOVE_KEYS	20101216

Events

Interface IF_BCFG_KEY_CONTAINER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_S_FIELD_VALUE	Public	See coding			20110110	begin of ty_s_field_value, " structure type for a single key field tablename type tabname, " target table for the value rec_id type i, " logical number used to group values belonging to the same table line (not stable across method invocations) fieldname type fieldname, " name of the key field value type string, " value in normalized form (ignored when generic = abap_true) generic type abap_bool, " set to 'abap_true' to make the key field generic (matching any value) end of ty_s_field_value
2	TY_T_FIELD_VALUES	Public	See coding			20110110	ty_t_field_values type sorted table of ty_s_field_value with non-unique key tablename rec_id fieldname

Method Signatures

Method ADD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_OTHER	Call by reference	☐	Object reference (TYPE REF TO)	IF_BCFG_KEY_CONTAINER		key container whose keys should be added to this one	20101118

Method ADD on Interface IF_BCFG_KEY_CONTAINER has no exception.

Method ADD_KEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_LINE	Call by reference	☐	Type reference (TYPE)	ANY		table line (non-key fields are ignored)	20101118
2	Importing	IV_SKIP_INITIAL	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	when true, initial values in 'is_line' will be skipped	20101118

#	Exception	Resumable	Description	Created on
1	CX_BCFG_MALFORMED_KEY	☐	if a key field violates the right-generic rule	20120323

Method ADD_KEYS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_LINES	Call by reference	☐	Type reference (TYPE)	ANY TABLE		table lines (values in non-key fields of lines are ignored)	20101118
2	Importing	IV_SKIP_INITIAL	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	when true, initial values in fields of lines will be skipped	20101118

#	Exception	Resumable	Description	Created on
1	CX_BCFG_MALFORMED_KEY	☐	if a key field violates the right-generic rule	20120323

Method ADD_KEYS_BY_FIELDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_FIELDS	Call by reference	☐	Type reference (TYPE)	TY_T_FIELD_VALUES		individual key field values, grouped by REC_ID	20101216

#	Exception	Resumable	Description	Created on
1	CX_BCFG_MALFORMED_KEY	☐	if a key field violates the right-generic rule	20120323

Method GET_KEYS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_LINES	Call by reference	☐	Type reference (TYPE)	ANY TABLE			20101118

Method GET_KEYS on Interface IF_BCFG_KEY_CONTAINER has no exception.

Method GET_KEYS_AS_FIELDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_FIELDS	Call by reference	☐	Type reference (TYPE)	TY_T_FIELD_VALUES		all key fields in the container, grouped by REC_ID	20101216

Method GET_KEYS_AS_FIELDS on Interface IF_BCFG_KEY_CONTAINER has no exception.

Method IS_EMPTY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		ABAP_TRUE if the container is empty	20101125

Method IS_EMPTY on Interface IF_BCFG_KEY_CONTAINER has no exception.

Method REMOVE_ALL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		ABAP_TRUE, unless the container was empty	20101125

Method REMOVE_ALL on Interface IF_BCFG_KEY_CONTAINER has no exception.

Method REMOVE_KEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_LINE	Call by reference	☐	Type reference (TYPE)	ANY		table line (non-key fields are ignored)	20101118
2	Importing	IV_SKIP_INITIAL	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	when true, initial values in 'is_line' will be skipped	20120403
3	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		returns true if a matching key was removed	20101125

#	Exception	Resumable	Description	Created on
1	CX_BCFG_MALFORMED_KEY	☐	if a key field violates the right-generic rule	20120403

Method REMOVE_KEYS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_LINES	Call by reference	☐	Type reference (TYPE)	ANY TABLE		table lines (values in non-key fields of lines are ignored)	20110517
2	Importing	IV_SKIP_INITIAL	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	when true, initial values in fields of lines will be skipped	20120403
3	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		returns true if any matching key was removed	20110517

#	Exception	Resumable	Description	Created on
1	CX_BCFG_MALFORMED_KEY	☐	if a key field violates the right-generic rule	20120403

Method REMOVE_KEYS_BY_FIELDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_FIELDS	Call by reference	☐	Type reference (TYPE)	TY_T_FIELD_VALUES		keys to be removed	20101216
2	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		tells whether matching keys were found	20101216

#	Exception	Resumable	Description	Created on
1	CX_BCFG_MALFORMED_KEY	☐	if a key field violates the right-generic rule	20120323

History

Last changed by/on	SAP	20130531
SAP Release Created in	703