SAP ABAP Class CL_SRM_PROP_REFERENCE_HANDLER (Record Number Generation in Property Unification)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-RM (Application Component) SAP Records Management
     ⤷ SRM_GSP_PROPERTY (Package) GSP (Record, Model,...): Property Handling

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SRM_PROP_REFERENCE	Generate/Check/Reserve Unique IDs	20030710

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_RMPS_PROP_REFERENCE_HANDLER	RMPS: Record Number Generation in Property Unification	20040402
2	Inheritance (c INHERITING FROM c_ref)	CL_SRM_PROP_REFERENCE_GSP	GSP: Record Number Generation in Property Unification	20030721

Properties

Class	CL_SRM_PROP_REFERENCE_HANDLER
Short Description	Record Number Generation in Property Unification
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	SRM_GSP_PROPERTY	GSP (Record, Model,...): Property Handling
Created	20030710	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
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...
2	SRMIF	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_SRM_PROP_REFERENCE	☐	☐	Generate/Check/Reserve Unique IDs	20030710

Friends

Class CL_SRM_PROP_REFERENCE_HANDLER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	C_BUTTID_NEW_DEFAULTS	Constant	Public	☐	Type reference (TYPE)	STRING	'SRM_NEW_DEFAULTS'	ID Button: Choose New Default for Record Number Generation	20030806
2	C_BUTTID_USE_CURRENT_DEFAULTS	Constant	Public	☐	Type reference (TYPE)	STRING	'SRM_USE_CURRENT_DEFAULTS'	ID Button: Use Current Default for Record Number Generation	20030806
3	C_MODE_CHECK	Constant	Protected	☐	Type reference (TYPE)	STRING	'CHECK'	Check ID	20030710
4	C_MODE_GENERATE	Constant	Protected	☐	Type reference (TYPE)	STRING	'GENERATE'	Generate ID	20030710
5	G_IF_SRM	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_SRM		General SRM Methods	20030710
6	G_IF_SRM_REFERENCE	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_SRM_REFERENCE		Reference Generator	20030710
7	G_POID	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_SRM_POID		POID of object whose ID is generated/checked	20030710
8	G_USE_DEFAULTS	Instance attribute	Protected	☐	Type reference (TYPE)	SRMBOOLEAN	IF_SRM=>FALSE	Use Default User Settings for Generation	20030710

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_CONTAINER_DEPENDENCY	Instance method	Public	Method	Check: ID Depends on Container ID? Container ID Given?	20030815
2	CHECK_GENERATION_ALLOWED	Instance method	Public	Method	Check: Generation Permitted Now? Otherwise Exception.	20030723
3	CHECK_INTERACTION_NECESSARY	Instance method	Public	Method	Check: User Interaction Required for ID Regeneration?	20030815
4	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20030710
5	COUNT_POSSIBLE_RULE_NAMES	Instance method	Public	Method	Counts Possible Rule Names	20030815
6	EXTEND_ENVIRONMENT	Instance method	Protected	Method	Extends Environment for Generating/Checking ID	20030710
7	GET_CONTAINER_OBJECT	Instance method	Public	Method	Gets Top Object	20030721
8	GET_CONTAINER_REFERENCE	Instance method	Public	Method	Gets ID of Top Object	20030721
9	GET_POSSIBLE_RULE_NAMES	Instance method	Public	Method	Gets Possible Rule Names	20030710
10	GET_REFERENCE_DATA	Instance method	Public	Method	Gets Current ID Values	20030710
11	GET_REFERENCE_SESSION	Instance method	Public	Method	Gets Session for Generating Record Numbers	20030710
12	GET_RULE_TYPE	Instance method	Public	Method	Get Rule Type	20030710
13	GET_SINGLE_ATTRIBUTE	Instance method	Protected	Method	Gets Attribute Value Object from ID	20030723
14	GET_SINGLE_STRING_VALUE	Instance method	Protected	Method	Gets Attribute Value (String, Single Value)	20030710
15	GET_USER_INTERACTION_ALLOWED	Instance method	Public	Method	User Interaction Permitted for Rule Query/Generation?	20030801
16	MODIFY_BUTTON_TABLE	Instance method	Protected	Method	Sets Given Setting in Button Table	20030811
17	PRELIMINARY_REFERENCE_CHECK	Instance method	Protected	Method	Check Before Syntax Check (by Subclasses)	20030807
18	SET_EXCEPTION_DATA	Instance method	Protected	Method	Writes Exception Data to Property Table	20030723
19	SET_REFERENCE_DATA	Instance method	Protected	Method	Sets Current ID Values	20030710
20	SET_SINGLE_STRING_VALUE	Instance method	Protected	Method	Sets Attribute Value (String, Single Value)	20030710

Events

Class CL_SRM_PROP_REFERENCE_HANDLER has no event.

Types

Class CL_SRM_PROP_REFERENCE_HANDLER has no local type.

Method Signatures

Method CHECK_CONTAINER_DEPENDENCY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_CONTAINER_REFERENCE	Call by reference	☐	Type reference (TYPE)	STRING		Container-Kennzeichen	20030815
2	Exporting	EX_CONTREF_IS_CORRESPONDING	Call by reference	☐	Type reference (TYPE)	SRMBOOLEAN		Container-Kennzeichen ist im Kennzeichen bereits enthalten	20030815
3	Exporting	EX_CONTREF_IS_EMPTY	Call by reference	☐	Type reference (TYPE)	SRMBOOLEAN		Container-Kennzeichen ist leer	20030815
4	Exporting	EX_DEPENDS_FROM_CONTREF	Call by reference	☐	Type reference (TYPE)	SRMBOOLEAN		Kennzeichen hängt vom Container-Kennzeichen ab	20030815
5	Importing	IM_CONTAINER_OBJECT	Value transfer	☑	Object reference (TYPE REF TO)	IF_SRM_POID		Container-Objekt	20030815
6	Importing	IM_CONTEXT	Value transfer	☑	Object reference (TYPE REF TO)	IF_SRM_PROP_CONTEXT		Kontext	20030815
7	Importing	IM_PROPERTY_TAB	Value transfer	☑	Type reference (TYPE)	SRM_LIST_ATTR_VAL_HDL		Property-Tabelle (nicht angegeben->Repository verwenden)	20030815

Method CHECK_CONTAINER_DEPENDENCY on class CL_SRM_PROP_REFERENCE_HANDLER has no exception.

Method CHECK_GENERATION_ALLOWED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_CONTEXT	Value transfer	☑	Object reference (TYPE REF TO)	IF_SRM_PROP_CONTEXT		Kontext	20030723
2	Importing	IM_PROPERTY_TAB	Value transfer	☐	Type reference (TYPE)	SRM_LIST_ATTR_VAL_HDL		Property-Tabelle	20030723

#	Exception	Resumable	Description	Created on
1	CX_SRM_PROP_REFERENCE	☐	Fehler bei der Aktenzeichengenerierung	20030723

Method CHECK_INTERACTION_NECESSARY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_CONTAINER_OBJECT	Value transfer	☑	Object reference (TYPE REF TO)	IF_SRM_POID		POID des umgebenden Objekts	20030815
2	Importing	IM_CONTEXT	Value transfer	☑	Object reference (TYPE REF TO)	IF_SRM_PROP_CONTEXT		Kontext	20030815
3	Importing	IM_PROPERTY_TAB	Value transfer	☑	Type reference (TYPE)	SRM_LIST_ATTR_VAL_HDL		Property-Tabelle (nicht angegeben->Repository verwenden)	20030815
4	Returning	RE_INTERACTION_NECESSARY	Value transfer	☐	Type reference (TYPE)	SRMBOOLEAN		Interaktion bei Neugenerierung d. Kennzeichens notwendig?	20030815

Method CHECK_INTERACTION_NECESSARY on class CL_SRM_PROP_REFERENCE_HANDLER has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_IF_SRM	Value transfer	☐	Object reference (TYPE REF TO)	IF_SRM			20030710
2	Importing	IM_POID	Value transfer	☐	Object reference (TYPE REF TO)	IF_SRM_POID			20030710

Method CONSTRUCTOR on class CL_SRM_PROP_REFERENCE_HANDLER has no exception.

Method COUNT_POSSIBLE_RULE_NAMES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_CONTEXT	Value transfer	☑	Object reference (TYPE REF TO)	IF_SRM_PROP_CONTEXT		Kontext	20030815
2	Importing	IM_RULE_NAME	Value transfer	☑	Type reference (TYPE)	STRING		Regelname(n)	20030815
3	Returning	RE_RULE_NAME_COUNT	Value transfer	☐	Type reference (TYPE)	I		Anzahl möglicher Regelnamen	20030815

Method COUNT_POSSIBLE_RULE_NAMES on class CL_SRM_PROP_REFERENCE_HANDLER has no exception.

Method EXTEND_ENVIRONMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_CONTEXT	Value transfer	☑	Object reference (TYPE REF TO)	IF_SRM_PROP_CONTEXT		Kontext	20030722
2	Importing	IM_ENVIRONMENT	Value transfer	☐	Object reference (TYPE REF TO)	CL_SRM_RF_VALUE_SET		Environment für Generierung/Check eines Kennzeichens	20030710
3	Importing	IM_MODE	Value transfer	☐	Type reference (TYPE)	STRING		Generierung oder Check (C_MODE_*)	20030710

Method EXTEND_ENVIRONMENT on class CL_SRM_PROP_REFERENCE_HANDLER has no exception.

Method GET_CONTAINER_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_CONTEXT	Value transfer	☑	Object reference (TYPE REF TO)	IF_SRM_PROP_CONTEXT		Kontext	20030722
2	Returning	RE_CONTAINER_OBJECT	Value transfer	☐	Object reference (TYPE REF TO)	IF_SRM_POID		Übergeordnetes Objekt	20030721

Method GET_CONTAINER_OBJECT on class CL_SRM_PROP_REFERENCE_HANDLER has no exception.

Method GET_CONTAINER_REFERENCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_CONTAINER_OBJECT	Value transfer	☑	Object reference (TYPE REF TO)	IF_SRM_POID		Übergeordnetes Objekt	20030721
2	Importing	IM_CONTEXT	Value transfer	☑	Object reference (TYPE REF TO)	IF_SRM_PROP_CONTEXT		Kontext	20030722
3	Returning	RE_CONTAINER_REFERENCE	Value transfer	☐	Type reference (TYPE)	STRING		Kennzeichen des übergeordneten Objekts	20030721

#	Exception	Resumable	Description	Created on
1	CX_SRM_PROP_REFERENCE	☐	Fehler bei der Aktenzeichengenerierung	20030721

Method GET_POSSIBLE_RULE_NAMES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_CONTEXT	Value transfer	☑	Object reference (TYPE REF TO)	IF_SRM_PROP_CONTEXT		Kontext	20030722
2	Returning	RE_RULE_NAMES	Value transfer	☐	Type reference (TYPE)	STRING		Mögl. Regelnamen (IF_SRM_REFERENCE=>RULENAME_SEPARATOR)	20030710

#	Exception	Resumable	Description	Created on
1	CX_SRM_PROP_REFERENCE	☐	Fehler bei der Aktenzeichengenerierung	20030710

Method GET_REFERENCE_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_REFERENCE	Value transfer	☐	Type reference (TYPE)	STRING		Kennzeichen	20030710
2	Exporting	EX_REFERENCE_OBJECT	Value transfer	☐	Object reference (TYPE REF TO)	IF_SRM_ATTRIBUTE_VALUE		Kennzeichen als Attributobjekt	20030723
3	Exporting	EX_RULE_NAME	Value transfer	☐	Type reference (TYPE)	STRING		Regelname	20030710
4	Exporting	EX_RULE_TYPE	Value transfer	☐	Type reference (TYPE)	STRING		Regeltyp	20030710
5	Importing	IM_CONTEXT	Value transfer	☑	Object reference (TYPE REF TO)	IF_SRM_PROP_CONTEXT		Kontext	20030722
6	Importing	IM_LAST_SAVED	Value transfer	☐	Type reference (TYPE)	SRMBOOLEAN	IF_SRM=>FALSE	Zuletzt gespeicherte Werte (T) od. akt. Werte aus Tab.(F)	20030723
7	Importing	IM_PROPERTY_TAB	Value transfer	☐	Type reference (TYPE)	SRM_LIST_ATTR_VAL_HDL		Property-Tabelle	20030710

#	Exception	Resumable	Description	Created on
1	CX_SRM_PROP_REFERENCE	☐	Fehler bei der Aktenzeichengenerierung	20030710

Method GET_REFERENCE_SESSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_CONTEXT	Value transfer	☐	Object reference (TYPE REF TO)	IF_SRM_PROP_CONTEXT		Kontext	20030710
2	Returning	RE_REFERENCE_SESSION	Value transfer	☐	Object reference (TYPE REF TO)	IF_SRM_REFERENCE_SESSION		Session für Generierung	20030710

Method GET_REFERENCE_SESSION on class CL_SRM_PROP_REFERENCE_HANDLER has no exception.

Method GET_RULE_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_CONTEXT	Value transfer	☑	Object reference (TYPE REF TO)	IF_SRM_PROP_CONTEXT		Kontext	20030722
2	Returning	RE_RULE_TYPE	Value transfer	☐	Type reference (TYPE)	STRING		Typ der Generierungsregel	20030710

#	Exception	Resumable	Description	Created on
1	CX_SRM_PROP_REFERENCE	☐	Fehler bei der Aktenzeichengenerierung	20030710

Method GET_SINGLE_ATTRIBUTE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_CONTEXT	Value transfer	☑	Object reference (TYPE REF TO)	IF_SRM_PROP_CONTEXT		Kontext	20030723
2	Importing	IM_ID	Value transfer	☐	Type reference (TYPE)	STRING		Attribut-ID	20030723
3	Importing	IM_LAST_SAVED	Value transfer	☐	Type reference (TYPE)	SRMBOOLEAN	IF_SRM=>FALSE	Zuletzt gespeicherten Wert (T) od. akt. Wert aus Tab.(F)	20030723
4	Importing	IM_PROPERTY_TAB	Call by reference	☐	Type reference (TYPE)	SRM_LIST_ATTR_VAL_HDL		Property-Tabelle	20030723
5	Returning	RE_ATTRIBUTE	Value transfer	☐	Object reference (TYPE REF TO)	IF_SRM_ATTRIBUTE_VALUE		Attributwert	20030723

#	Exception	Resumable	Description	Created on
1	CX_SRM_PROP_REFERENCE	☐	Fehler bei der Aktenzeichengenerierung	20030723

Method GET_SINGLE_STRING_VALUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_CONTEXT	Value transfer	☑	Object reference (TYPE REF TO)	IF_SRM_PROP_CONTEXT		Kontext	20030722
2	Importing	IM_ID	Value transfer	☐	Type reference (TYPE)	STRING		Attribut-ID	20030710
3	Importing	IM_PROPERTY_TAB	Call by reference	☐	Type reference (TYPE)	SRM_LIST_ATTR_VAL_HDL		Property-Tabelle	20030710
4	Returning	RE_VALUE	Value transfer	☐	Type reference (TYPE)	STRING		Attributwert	20030710

#	Exception	Resumable	Description	Created on
1	CX_SRM_PROP_REFERENCE	☐	Fehler bei der Aktenzeichengenerierung	20030710

Method GET_USER_INTERACTION_ALLOWED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_CONTEXT	Value transfer	☑	Object reference (TYPE REF TO)	IF_SRM_PROP_CONTEXT		Kontext	20030801
2	Returning	RE_INTERACTION_ALLOWED	Value transfer	☐	Type reference (TYPE)	SRMBOOLEAN		Benutzereingaben bei Regelabfrage/Generierung erlaubt?	20030801

Method GET_USER_INTERACTION_ALLOWED on class CL_SRM_PROP_REFERENCE_HANDLER has no exception.

Method MODIFY_BUTTON_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CH_BUTTON_TABLE	Call by reference	☐	Type reference (TYPE)	SRM_LIST_BUTTON		Buttontabelle für das eindeutige Kennzeichen	20030811
2	Importing	IM_USE_DEFAULTS	Value transfer	☐	Type reference (TYPE)	SRMBOOLEAN		Zu setzender Einstellungswert	20030811

Method MODIFY_BUTTON_TABLE on class CL_SRM_PROP_REFERENCE_HANDLER has no exception.

Method PRELIMINARY_REFERENCE_CHECK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CH_PROPERTY_TAB	Call by reference	☐	Type reference (TYPE)	SRM_LIST_ATTR_VAL_HDL		Property-Tabelle	20030807
2	Exporting	EX_CHECK_OK	Call by reference	☐	Type reference (TYPE)	SRMBOOLEAN		Kennzeichen ok?	20030807
3	Importing	IM_CONTEXT	Value transfer	☑	Object reference (TYPE REF TO)	IF_SRM_PROP_CONTEXT		Kontext	20030807
4	Importing	IM_REFERENCE	Value transfer	☐	Type reference (TYPE)	STRING		Kennzeichen	20030807
5	Importing	IM_REFERENCE_OBJECT	Value transfer	☐	Object reference (TYPE REF TO)	IF_SRM_ATTRIBUTE_VALUE		Attribut-Objekt des Kennzeichens	20030807
6	Importing	IM_RULE_NAME	Value transfer	☐	Type reference (TYPE)	STRING		Regelname	20030807
7	Importing	IM_RULE_TYPE	Value transfer	☐	Type reference (TYPE)	STRING		Regeltyp	20030807

#	Exception	Resumable	Description	Created on
1	CX_SRM_PROP_REFERENCE	☐	Fehler bei der Aktenzeichengenerierung	20030807

Method SET_EXCEPTION_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CH_PROPERTY_TAB	Call by reference	☐	Type reference (TYPE)	SRM_LIST_ATTR_VAL_HDL		Property-Tabelle	20030723
2	Importing	IM_CONTEXT	Value transfer	☑	Object reference (TYPE REF TO)	IF_SRM_PROP_CONTEXT		Kontext	20030723
3	Importing	IM_EXCEPTION	Value transfer	☐	Object reference (TYPE REF TO)	CX_ROOT		Zu schreibende Exception	20030723

Method SET_EXCEPTION_DATA on class CL_SRM_PROP_REFERENCE_HANDLER has no exception.

Method SET_REFERENCE_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CH_PROPERTY_TAB	Call by reference	☐	Type reference (TYPE)	SRM_LIST_ATTR_VAL_HDL		Property-Tabelle	20030721
2	Importing	IM_CONTEXT	Value transfer	☑	Object reference (TYPE REF TO)	IF_SRM_PROP_CONTEXT		Kontext	20030722
3	Importing	IM_REFERENCE	Call by reference	☑	Type reference (TYPE)	STRING		Kennzeichen	20030721
4	Importing	IM_RULE_NAME	Call by reference	☑	Type reference (TYPE)	STRING		Regelname	20030721
5	Importing	IM_RULE_TYPE	Call by reference	☑	Type reference (TYPE)	STRING		Regeltyp	20030721

#	Exception	Resumable	Description	Created on
1	CX_SRM_PROP_REFERENCE	☐	Fehler bei der Aktenzeichengenerierung	20030710

Method SET_SINGLE_STRING_VALUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CH_PROPERTY_TAB	Call by reference	☐	Type reference (TYPE)	SRM_LIST_ATTR_VAL_HDL		Property-Tabelle	20030710
2	Importing	IM_CONTEXT	Value transfer	☑	Object reference (TYPE REF TO)	IF_SRM_PROP_CONTEXT		Kontext	20030722
3	Importing	IM_ID	Value transfer	☐	Type reference (TYPE)	STRING		Attribut-ID	20030710
4	Importing	IM_VALUE	Value transfer	☐	Type reference (TYPE)	STRING		Attributwert	20030710

#	Exception	Resumable	Description	Created on
1	CX_SRM_PROP_REFERENCE	☐	Fehler bei der Aktenzeichengenerierung	20030710

History

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