SAP ABAP Class CL_SRM_RG_CREATION_RULE (RNG: Generation rule)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-RM (Application Component) SAP Records Management
     ⤷ SRM_RECORD_FACILITIES (Package) Tools and Add-Ons for Records Management

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_SRM_RG_RULE_ELEMENT_LIST	RNG: List of rule elements	20010809

Properties

Class	CL_SRM_RG_CREATION_RULE
Short Description	RNG: Generation rule
Super Class	CL_SRM_RG_RULE_ELEMENT_LIST	RNG: List of rule elements
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SRM_RECORD_FACILITIES	Tools and Add-Ons for Records Management
Created	20010711	SAP
Last change	20010809	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	SRMRF	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
2	SRMRG	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_SRM_RG_CREATION_RULE has no interface implemented.

Friends

#	Friend	Modeled only	Created on	Description
1	CL_SRM_RG_CREATION_RULE_UI	☐	20020110	RNG: User Interface for generation rule
2	CL_SRM_SP_REFERENCE	☐	20020723	Reference Generator

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	INFO_DESCRIPTION	Constant	Public	☐	Type reference (TYPE)	STRING	'DESCRIPTION'	Description	20020115
2	INFO_INPUT_TYPE	Constant	Public	☐	Type reference (TYPE)	STRING	'INPUT_TYPE'	Input Type	20020110
3	INFO_SYNTAX_CHECK	Constant	Public	☐	Type reference (TYPE)	STRING	'SYNTAX_CHECK'	Syntax Check	20020110
4	INFO_UNIQUE_CHECK	Constant	Public	☐	Type reference (TYPE)	STRING	'UNIQUE_CHECK'	Ambiguity check	20020110
5	ITYPE_DIRECT	Constant	Public	☐	Type reference (TYPE)	STRING	'LIN'	Input Type: Direct Input	20020110
6	ITYPE_INTERACTIVE	Constant	Public	☐	Type reference (TYPE)	STRING	'INT'	Input Type: Interactive	20020110
7	MY_LIST	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_SRM_HL_LIST		List for Rule	20010810
8	MY_TYPE	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Own Type	20020110

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_DEFINITION	Instance method	Public	Method	Check the Rule Definition	20020724
2	CHECK_PARTS_STORED	Instance method	Public	Method	Check Whether Parts for Rule in Database	20020725
3	CHECK_REFERENCE	Instance method	Public	Method	Check Record Number	20020215
4	COMMIT_IF_NECESSARY	Instance method	Protected	Method	Execute COMMIT WORK, If Necessary	20020731
5	CONNECT	Instance method	Public	Method	Make Connection to Generation Rule	20010810
6	CONNECT_ELEMENT	Instance method	Public	Method	Make Connection to Rule Element	20011002
7	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20010810
8	COPY	Instance method	Public	Method	Create Copy of Rule	20011020
9	CREATE	Static method	Public	Method	Create New Generation Rule	20011013
10	CREATE_ELEMENT	Instance method	Public	Method	Create New Element for Generation Rule	20011013
11	CREATE_REFERENCE	Instance method	Public	Method	Generate Record Number	20020709
12	DELETE	Instance method	Public	Method	Delete Rule	20020115
13	GET_LIST_TYPE	Static method	Protected	Method	Get List Types for Rule Types	20011009
14	GET_REFERENCE_KEY_DATA	Instance method	Protected	Method	Get Key Data for Access to Stored Reference	20020715
15	GET_REFERENCE_PARTS	Instance method	Public	Method	Get Part of a Record Number	20020723
16	GET_RULES	Static method	Public	Method	Get Existing Rules for a Type	20011009
17	GET_RULE_TYPE	Instance method	Public	Method	Get Rule Type	20020110
18	GET_TYPE_DESC	Static method	Public	Method	Get Output String for a Type	20010810
19	IS_RESERVED	Instance method	Public	Method	Checks Whether a Record Number is Already Reserved	20020122
20	LOAD_REFERENCE	Instance method	Public	Method	Load Reference (Database -> Environment)	20020711
21	LOCK_DEFINITION	Instance method	Public	Method	Lock Rule Definition (Write Lock)	20020725
22	MOVE_ELEMENT	Instance method	Public	Method	Moves Rule Element	20021217
23	PREPARE_ENVIRONMENT	Instance method	Protected	Method	Prepare Environment Before Generation	20020711
24	REMOVE_REFERENCE	Instance method	Public	Method	Delete Saved Record Number	20020715
25	RESERVE_REFERENCE	Instance method	Public	Method	Reserve Record Number	20020121
26	SAVE_REFERENCE	Instance method	Public	Method	Save Record Number (Environment->DB)	20020709
27	TRANSPORT	Instance method	Public	Method	Transport Rules	20030902
28	UNLOCK_DEFINITION	Instance method	Public	Method	Lift Write Lock for Rule Definition	20020725
29	UNRESERVE_REFERENCE	Instance method	Public	Method	Lift Reservation for Reference	20020613

Events

Class CL_SRM_RG_CREATION_RULE has no event.

Types

Class CL_SRM_RG_CREATION_RULE has no local type.

Method Signatures

Method CHECK_DEFINITION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ENVIRONMENT	Value transfer	☐	Object reference (TYPE REF TO)	CL_SRM_RF_VALUE_SET		Environment	20020724

Method CHECK_DEFINITION on class CL_SRM_RG_CREATION_RULE has no exception.

Method CHECK_PARTS_STORED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	PARTS_ARE_STORED	Value transfer	☐	Type reference (TYPE)	SRMRF_BOOLEAN		Flag, ob zur Regel Bestandteile in der DB gespeichert sind	20020725

Method CHECK_PARTS_STORED on class CL_SRM_RG_CREATION_RULE has no exception.

Method CHECK_REFERENCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ENV	Value transfer	☐	Object reference (TYPE REF TO)	CL_SRM_RF_VALUE_SET		Wertemenge	20020215
2	Importing	REFERENCE	Value transfer	☐	Type reference (TYPE)	STRING			20020215
3	Returning	REFERENCE_OK	Value transfer	☐	Type reference (TYPE)	SRMRF_BOOLEAN			20020215
4	Importing	THROW_EXCEPTION	Value transfer	☐	Type reference (TYPE)	SRMRF_BOOLEAN	SRMRF_FALSE	Exception bei nicht erfolgreicher Prüfung	20020708

Method CHECK_REFERENCE on class CL_SRM_RG_CREATION_RULE has no exception.

Method COMMIT_IF_NECESSARY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ENVIRONMENT	Value transfer	☐	Object reference (TYPE REF TO)	CL_SRM_RF_VALUE_SET		Umgebung	20020731

Method COMMIT_IF_NECESSARY on class CL_SRM_RG_CREATION_RULE has no exception.

Method CONNECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NAME	Value transfer	☐	Type reference (TYPE)	STRING		Name der Regel	20010810
2	Importing	TYPE	Value transfer	☐	Type reference (TYPE)	STRING		Siehe Konstanten TYPE_*	20011009

Method CONNECT on class CL_SRM_RG_CREATION_RULE has no exception.

Method CONNECT_ELEMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ELEMENT_ID	Value transfer	☐	Type reference (TYPE)	STRING			20011002
2	Returning	RETURN	Value transfer	☐	Object reference (TYPE REF TO)	CL_SRM_RG_RULE_ELEMENT		Aktenzeichengenerierer: Regelelement	20011002

Method CONNECT_ELEMENT on class CL_SRM_RG_CREATION_RULE has no exception.

Method CONSTRUCTOR Signature

Method CONSTRUCTOR on class CL_SRM_RG_CREATION_RULE has no parameter.
Method CONSTRUCTOR on class CL_SRM_RG_CREATION_RULE has no exception.

Method COPY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DESCRIPTION	Value transfer	☐	Type reference (TYPE)	STRING		Beschreibung	20011020
2	Importing	NAME	Value transfer	☐	Type reference (TYPE)	STRING		Name der Regel	20011020
3	Returning	RULE	Value transfer	☐	Object reference (TYPE REF TO)	CL_SRM_RG_CREATION_RULE		Laufzeitinstanz der Kopie	20011020
4	Importing	TYPE	Value transfer	☐	Type reference (TYPE)	STRING		Typ der Regel	20011020

Method COPY on class CL_SRM_RG_CREATION_RULE has no exception.

Method CREATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DESCRIPTION	Value transfer	☐	Type reference (TYPE)	STRING		Beschreibung	20011013
2	Importing	NAME	Value transfer	☐	Type reference (TYPE)	STRING		Name der Regel	20011013
3	Importing	TYPE	Value transfer	☐	Type reference (TYPE)	STRING		Siehe Konstanten TYPE_*	20011013

Method CREATE on class CL_SRM_RG_CREATION_RULE has no exception.

Method CREATE_ELEMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ELEMENT_ID	Value transfer	☐	Type reference (TYPE)	STRING		Element-ID des neuen Regelelementes	20011013
2	Importing	SIBLING	Value transfer	☐	Type reference (TYPE)	STRING		ID des Nachbarn, hinter den das Element angelegt werden soll	20011013
3	Importing	TYPE	Value transfer	☐	Type reference (TYPE)	STRING		Typ des Regelelementes	20011013

Method CREATE_ELEMENT on class CL_SRM_RG_CREATION_RULE has no exception.

Method CREATE_REFERENCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ENVIRONMENT	Value transfer	☐	Object reference (TYPE REF TO)	CL_SRM_RF_VALUE_SET		Umgebung	20020709
2	Exporting	RESULT	Value transfer	☐	Type reference (TYPE)	STRING		Ergebnis	20020709
3	Importing	USER_INTERFACE	Value transfer	☐	Object reference (TYPE REF TO)	CL_SRM_RG_CREATION_RULE_UI		Referenz auf Benutzer-Interface	20020709

Method CREATE_REFERENCE on class CL_SRM_RG_CREATION_RULE has no exception.

Method DELETE Signature

Method DELETE on class CL_SRM_RG_CREATION_RULE has no parameter.
Method DELETE on class CL_SRM_RG_CREATION_RULE has no exception.

Method GET_LIST_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	LIST_TYPE	Value transfer	☐	Type reference (TYPE)	STRING		Listentyp	20011009
2	Importing	RULE_TYPE	Value transfer	☐	Type reference (TYPE)	STRING		Regeltyp	20011009

Method GET_LIST_TYPE on class CL_SRM_RG_CREATION_RULE has no exception.

Method GET_REFERENCE_KEY_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ENVIRONMENT	Value transfer	☐	Object reference (TYPE REF TO)	CL_SRM_RF_VALUE_SET		Environment	20020715
2	Importing	REFERENCE	Value transfer	☐	Type reference (TYPE)	STRING		Aktenzeichen	20020715
3	Exporting	REF_ID	Value transfer	☐	Type reference (TYPE)	STRING			20020715
4	Exporting	RMS_ID	Value transfer	☐	Type reference (TYPE)	STRING			20020715
5	Exporting	RULE_NAME	Value transfer	☐	Type reference (TYPE)	STRING			20020715
6	Exporting	RULE_TYPE	Value transfer	☐	Type reference (TYPE)	STRING			20020715

Method GET_REFERENCE_KEY_DATA on class CL_SRM_RG_CREATION_RULE has no exception.

Method GET_REFERENCE_PARTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ENVIRONMENT	Value transfer	☐	Object reference (TYPE REF TO)	CL_SRM_RF_VALUE_SET		Environment	20020723
2	Importing	GET_RESULT_TAB_ONLY	Value transfer	☐	Type reference (TYPE)	SRMRF_BOOLEAN	SRMRF_TRUE	Nur Ergebnistabelle ohne Zuordnung zu Regeldefinition lesen?	20020723
3	Exporting	NUM_ELEMS_WITHOUT_PART	Value transfer	☐	Type reference (TYPE)	I		Anzahl der Elemente in Regeldefinition ohne Ergebnis	20020723
4	Exporting	NUM_PARTS_WITHOUT_ELEM	Value transfer	☐	Type reference (TYPE)	I		Anzahl der Bestandteile ohne Element in Regeldefinition	20020723
5	Importing	REFERENCE	Value transfer	☐	Type reference (TYPE)	STRING		Aktenzeichen	20020723
6	Exporting	RESULT_TAB	Value transfer	☐	Type reference (TYPE)	SRMRG_REF_RESULT_TAB		Gespeicherte Ergebnisse der Bestandteile des Kennzeichens	20020723
7	Exporting	RULE_DEF_TAB	Value transfer	☐	Type reference (TYPE)	SRMRG_RULE_DEF_TAB		Regeldefinition	20020723

Method GET_REFERENCE_PARTS on class CL_SRM_RG_CREATION_RULE has no exception.

Method GET_RULES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RULES	Value transfer	☐	Object reference (TYPE REF TO)	CL_SRM_RF_ELEMENT_ITER		Hier die Liste	20011009
2	Importing	TYPE	Value transfer	☐	Type reference (TYPE)	STRING		Siehe Konstanten TYPE_*	20011009

Method GET_RULES on class CL_SRM_RG_CREATION_RULE has no exception.

Method GET_RULE_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RETURN	Value transfer	☐	Type reference (TYPE)	STRING		Regeltyp	20020110

Method GET_RULE_TYPE on class CL_SRM_RG_CREATION_RULE has no exception.

Method GET_TYPE_DESC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	TYPE	Value transfer	☐	Type reference (TYPE)	STRING		Typ des Elementes	20010810
2	Returning	TYPE_STRING	Value transfer	☐	Type reference (TYPE)	STRING		Ausgabestring	20010810

Method GET_TYPE_DESC on class CL_SRM_RG_CREATION_RULE has no exception.

Method IS_RESERVED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ENV	Value transfer	☐	Object reference (TYPE REF TO)	CL_SRM_RF_VALUE_SET		Umgebung - zusätzliche Kommunikationsschnittstelle	20020122
2	Importing	REFERENCE	Value transfer	☐	Type reference (TYPE)	STRING		Aktenzeichen	20020122
3	Returning	RESERVED	Value transfer	☐	Type reference (TYPE)	SRMRF_BOOLEAN		Schon reserviert	20020122

Method IS_RESERVED on class CL_SRM_RG_CREATION_RULE has no exception.

Method LOAD_REFERENCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ENVIRONMENT	Value transfer	☐	Object reference (TYPE REF TO)	CL_SRM_RF_VALUE_SET		Umgebung	20020711
2	Importing	REFERENCE	Value transfer	☐	Type reference (TYPE)	STRING		Aktenzeichen, das zu laden ist	20020711
3	Importing	THROW_EXCEPTION	Value transfer	☐	Type reference (TYPE)	SRMRF_BOOLEAN	SRMRF_FALSE	Exception, wenn keine Daten zum Aktenzeichen in DB?	20020711
4	Importing	VALUE_TYPE	Value transfer	☐	Type reference (TYPE)	STRING	SRMRG_ENV_VALUE_TYPE_DBI	Typ der "Ziel"variablen im Environment	20020711

Method LOAD_REFERENCE on class CL_SRM_RG_CREATION_RULE has no exception.

Method LOCK_DEFINITION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ENQUE_MODE	Value transfer	☐	Type reference (TYPE)	ENQMODE	'E'	Sperrmodus: E=Schreib-, S=Lese-, X=erweiterte Schreibsperre	20020807

Method LOCK_DEFINITION on class CL_SRM_RG_CREATION_RULE has no exception.

Method MOVE_ELEMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ELEMENT	Value transfer	☐	Type reference (TYPE)	STRING		zu verschiebendes Element	20021217
2	Importing	NEW_SIBLING	Value transfer	☐	Type reference (TYPE)	STRING		ID des Nachbarn, hinter den das Element angelegt werden soll	20021217

Method MOVE_ELEMENT on class CL_SRM_RG_CREATION_RULE has no exception.

Method PREPARE_ENVIRONMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ENVIRONMENT	Value transfer	☐	Object reference (TYPE REF TO)	CL_SRM_RF_VALUE_SET		Umgebung	20020711

Method PREPARE_ENVIRONMENT on class CL_SRM_RG_CREATION_RULE has no exception.

Method REMOVE_REFERENCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ENVIRONMENT	Value transfer	☐	Object reference (TYPE REF TO)	CL_SRM_RF_VALUE_SET		Umgebung - zusätzliche Kommunikationsschnittstelle	20020715
2	Importing	REFERENCE	Value transfer	☐	Type reference (TYPE)	STRING		Aktenzeichen, das zu löschen ist	20020715

Method REMOVE_REFERENCE on class CL_SRM_RG_CREATION_RULE has no exception.

Method RESERVE_REFERENCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ENVIRONMENT	Value transfer	☐	Object reference (TYPE REF TO)	CL_SRM_RF_VALUE_SET		Umgebung - zusätzliche Kommunikationsschnittstelle	20020121
2	Returning	OK	Value transfer	☐	Type reference (TYPE)	SRMRF_BOOLEAN			20020218
3	Importing	REFERENCE	Value transfer	☐	Type reference (TYPE)	STRING		Aktenzeichen, das reserviert wird	20020121
4	Importing	THROW_EXCEPTION	Value transfer	☐	Type reference (TYPE)	SRMRF_BOOLEAN	SRMRF_FALSE	Falls reserviert: Exception werfen?	20020708

Method RESERVE_REFERENCE on class CL_SRM_RG_CREATION_RULE has no exception.

Method SAVE_REFERENCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ENVIRONMENT	Value transfer	☐	Object reference (TYPE REF TO)	CL_SRM_RF_VALUE_SET		Umgebung mit Teilergebnissen der Regelelemente (OUT~*)	20020709
2	Importing	REFERENCE	Call by reference	☐	Type reference (TYPE)	STRING		Aktenzeichen, das zu speichern ist	20020709

Method SAVE_REFERENCE on class CL_SRM_RG_CREATION_RULE has no exception.

Method TRANSPORT Signature

Method TRANSPORT on class CL_SRM_RG_CREATION_RULE has no parameter.
Method TRANSPORT on class CL_SRM_RG_CREATION_RULE has no exception.

Method UNLOCK_DEFINITION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ENQUE_MODE	Value transfer	☐	Type reference (TYPE)	ENQMODE	'E'	Sperrmodus (derselbe wie bei LOCK_DEFINITION!!)	20020807

Method UNLOCK_DEFINITION on class CL_SRM_RG_CREATION_RULE has no exception.

Method UNRESERVE_REFERENCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ENVIRONMENT	Value transfer	☐	Object reference (TYPE REF TO)	CL_SRM_RF_VALUE_SET		Umgebung - zusätzliche Kommunikationsschnittstelle	20020613
2	Returning	OK	Value transfer	☐	Type reference (TYPE)	SRMRF_BOOLEAN			20020613
3	Importing	REFERENCE	Value transfer	☐	Type reference (TYPE)	STRING		Aktenzeichen, dessen Reservierung aufgehoben wird	20020613
4	Importing	REMOVE_REFERENCE	Value transfer	☐	Type reference (TYPE)	SRMRF_BOOLEAN	SRMRF_TRUE	Sollen die gespeicherten Bestandteile gelöscht werden?	20020715

Method UNRESERVE_REFERENCE on class CL_SRM_RG_CREATION_RULE has no exception.

History

Last changed by/on	SAP	20010809
SAP Release Created in	610