SAP ABAP Interface IF_SRM_REFERENCE (Interface for Record Number Generator)

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 - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	CL_SRM_SP_REFERENCE	Reference Generator	20020117

Properties

Interface	IF_SRM_REFERENCE
Short Description	Interface for Record Number Generator

General Data

Package	SRM_RECORD_FACILITIES	Tools and Add-Ons for Records Management
Created	20010928	SAP
Last changed	00000000	SAP
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

Interface IF_SRM_REFERENCE has no interface.

Friends

Interface IF_SRM_REFERENCE has no friend.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	ENV_REF_OBJECT_TID	Constant	Public	☐	Type reference (TYPE)	STRING	'REF_OBJECT_TID'	Technical ID of Record Number Owner Object	20020430
2	PROP_RULE	Constant	Private	☐	Type reference (TYPE)	STRING	'SRM_REF_RULE'	Property Name for RNG Rule	20020121
3	RULEDEF_CONTAINER_ID	Constant	Public	☐	Type reference (TYPE)	STRING	'CONTAINER_ID'	Rule Element Name for ID of Top Level Object	20020925
4	RULENAME_SEPARATOR	Constant	Public	☐	Type reference (TYPE)	STRING	SRMRG_RULENAME_SEPARATOR	Separator for Transfer of Multiple Rule Names	20020708
5	TYPE_CASE	Constant	Public	☐	Type reference (TYPE)	STRING	'CAS'	Rule Type: Activity Indicator	20020807
6	TYPE_DOCUMENT	Constant	Private	☐	Type reference (TYPE)	STRING	'DOC'	Rule Type: Document Number	20020117
7	TYPE_RECORD	Constant	Private	☐	Type reference (TYPE)	STRING	'REC'	Rule Type: Record Number	20020117

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_REFERENCE	Instance method	Public	Method	Check Record Number	20010928
2	CREATE_REFERENCE	Instance method	Public	Method	Create Record Number	20010928
3	EVAL_ELEMENT	Instance method	Public	Method	Evaluate a Rule Element (As in Generation)	20020614
4	GET_NEW_REFERENCE_SESSION	Instance method	Public	Method	Gets New Session for Generating Record Numbers	20030529
5	GET_REFERENCE_PARTS	Instance method	Public	Method	Get Part of a Record Number	20020724
6	GET_RULE_DEFINITION	Instance method	Public	Method	Read a Rule Definition	20020612
7	GET_RULE_NAME	Instance method	Protected	Method	Get Name of Rule	20020813
8	GET_VALUE_FROM_REFERENCE	Instance method	Public	Method	Gets Value of Rule Element (from Elem. Name) from Rec. No.	20030815
9	PRESET_ELEMENT_VALUE	Instance method	Public	Method	Reserve Value for Rule Element with Given Name (Before Gen.)	20020925
10	REMOVE_REFERENCE	Instance method	Public	Method	Deletes Saved Parts of Record Number	20020920
11	RESERVE_REFERENCE	Instance method	Public	Method	Reserve Record Number (if required)	20010928
12	UNRESERVE_REFERENCE	Instance method	Public	Method	Unreserve Reservation of a Record Number	20020614

Events

Interface IF_SRM_REFERENCE has no event.

Types

Interface IF_SRM_REFERENCE has no local type.

Method Signatures

Method CHECK_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	20020117
2	Importing	REFERENCE	Value transfer	☐	Type reference (TYPE)	STRING		Zu prüfendes Aktenzeichen	20020117
3	Exporting	REFERENCE_OK	Value transfer	☐	Type reference (TYPE)	SRMRF_BOOLEAN		Das Aktenzeichen ist OK?	20020117
4	Exporting	RULE_NAME	Value transfer	☐	Type reference (TYPE)	STRING		Name der verwendeten Regel	20020117
5	Importing	RULE_NAME_IN	Value transfer	☑	Type reference (TYPE)	STRING		Vorgegebene(r) Regelname(n) (Trenner RULE_NAME_SEPARATOR)	20020122
6	Importing	THROW_EXCEPTION	Value transfer	☐	Type reference (TYPE)	SRMRF_BOOLEAN	SRMRF_FALSE	Bei fehlerhaftem Aktenzeichen Exception werfen?	20020708
7	Importing	TYPE	Value transfer	☐	Type reference (TYPE)	STRING		Regeltyp	20020117

Method CHECK_REFERENCE on Interface IF_SRM_REFERENCE has no exception.

Method CREATE_REFERENCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	COMMIT_IF_NECESSARY	Value transfer	☐	Type reference (TYPE)	SRMRF_BOOLEAN	SRMRF_TRUE	Commit ausführen, wenn notwendig?	20020731
2	Importing	ENVIRONMENT	Value transfer	☐	Object reference (TYPE REF TO)	CL_SRM_RF_VALUE_SET		Umgebung - zusätzliche Kommunikationsschnittstelle	20020117
3	Exporting	REFERENCE	Value transfer	☐	Type reference (TYPE)	STRING		Generiertes Aktenzeichen	20020117
4	Exporting	RULE_NAME	Value transfer	☐	Type reference (TYPE)	STRING		Name der verwendeten Regel	20020117
5	Importing	RULE_NAME_IN	Value transfer	☑	Type reference (TYPE)	STRING		Vorgegebene(r) Regelname(n) (Trenner RULE_NAME_SEPARATOR)	20020708
6	Importing	TYPE	Value transfer	☐	Type reference (TYPE)	STRING		Art der zu verwendenden Regel	20020117
7	Importing	USE_DEFAULTS	Value transfer	☐	Type reference (TYPE)	SRMRF_BOOLEAN		Defaultwerte verwenden?	20020117

Method CREATE_REFERENCE on Interface IF_SRM_REFERENCE has no exception.

Method EVAL_ELEMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ELEMENT_NAME	Value transfer	☐	Type reference (TYPE)	STRING		Name des auszuwertenden Elements	20020614
2	Importing	ENVIRONMENT	Value transfer	☐	Object reference (TYPE REF TO)	CL_SRM_RF_VALUE_SET		Umgebung - zusätzliche Kommunikationsschnittstelle	20020614
3	Exporting	RESULT	Value transfer	☐	Type reference (TYPE)	STRING		Ergebnis der Elementauswertung	20020614
4	Importing	RULE_NAME	Value transfer	☐	Type reference (TYPE)	STRING		Regelname	20020614
5	Importing	RULE_TYPE	Value transfer	☐	Type reference (TYPE)	STRING		Regeltyp	20020614

Method EVAL_ELEMENT on Interface IF_SRM_REFERENCE has no exception.

Method GET_NEW_REFERENCE_SESSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_SAVED_REFERENCE	Value transfer	☐	Type reference (TYPE)	SRMRGREFKY		Aktuell gespeichertes Aktenzeichen	20030529
2	Returning	RE_SESSION	Value transfer	☐	Object reference (TYPE REF TO)	IF_SRM_REFERENCE_SESSION		Neue Session	20030529

Method GET_NEW_REFERENCE_SESSION on Interface IF_SRM_REFERENCE 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		Umgebung - zusätzliche Kommunikationsschnittstelle	20020724
2	Importing	GET_RESULT_TAB_ONLY	Value transfer	☐	Type reference (TYPE)	SRMRF_BOOLEAN	SRMRF_TRUE	Nur Ergebnistabelle ohne Zuordnung zu Regeldefinition lesen?	20020724
3	Exporting	NUM_ELEMS_WITHOUT_PART	Value transfer	☐	Type reference (TYPE)	I		Anzahl der Elemente in Regeldefinition ohne Ergebnis	20020724
4	Exporting	NUM_PARTS_WITHOUT_ELEM	Value transfer	☐	Type reference (TYPE)	I		Anzahl der Bestandteile ohne Element in Regeldefinition	20020724
5	Importing	REFERENCE	Value transfer	☐	Type reference (TYPE)	STRING		Aktenzeichen, dessen Bestandteile zu lesen sind	20020724
6	Exporting	RESULT_TAB	Value transfer	☐	Type reference (TYPE)	SRMRG_REF_RESULT_TAB		Gespeicherte Ergebnisse der Bestandteile des Aktenzeichens	20020724
7	Exporting	RULE_DEF_TAB	Value transfer	☐	Type reference (TYPE)	SRMRG_RULE_DEF_TAB		Regeldefinition	20020724
8	Importing	RULE_NAME	Value transfer	☐	Type reference (TYPE)	STRING		Regelname	20020724
9	Importing	RULE_TYPE	Value transfer	☐	Type reference (TYPE)	STRING		Regeltyp	20020724

Method GET_REFERENCE_PARTS on Interface IF_SRM_REFERENCE has no exception.

Method GET_RULE_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		Umgebung - zusätzliche Kommunikationsschnittstelle	20020717
2	Exporting	RULE_DEFINITION	Call by reference	☐	Type reference (TYPE)	SRMRG_RULE_DEF_TAB		Regeldefinition	20020612
3	Importing	RULE_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Regelname	20020612
4	Importing	RULE_TYPE	Call by reference	☐	Type reference (TYPE)	STRING		Regeltyp	20020612

Method GET_RULE_DEFINITION on Interface IF_SRM_REFERENCE has no exception.

Method GET_RULE_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ASK_FOR_RULE_NAME	Value transfer	☐	Type reference (TYPE)	SRMRF_BOOLEAN		Benutzer nach Regelname fragen, falls notwendig?	20020813
2	Importing	ENVIRONMENT	Value transfer	☐	Object reference (TYPE REF TO)	CL_SRM_RF_VALUE_SET		Umgebung - zusätzliche Kommunikationsschnittstelle	20020813
3	Returning	RULE_NAME	Value transfer	☐	Type reference (TYPE)	STRING		Resultierender Regelname	20020813
4	Importing	RULE_NAME_IN	Value transfer	☑	Type reference (TYPE)	STRING		Regelname(n) (getrennt durch SRMRG_ENVNAME_SEPARATOR1)	20020813
5	Importing	RULE_TYPE	Value transfer	☐	Type reference (TYPE)	STRING		Regeltyp	20020813

Method GET_RULE_NAME on Interface IF_SRM_REFERENCE has no exception.

Method GET_VALUE_FROM_REFERENCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_VALUE_ADDITIONAL	Value transfer	☐	Type reference (TYPE)	STRING		Ggf. zusätzliches Ergebnis d. Regelelements (z.B. Schl. OU)	20030815
2	Exporting	EX_VALUE_IN_REFERENCE	Value transfer	☐	Type reference (TYPE)	STRING		Wert des Regelelements, der Teil des Aktenzeichens ist	20030815
3	Importing	IM_ELEMENT_NAME	Value transfer	☐	Type reference (TYPE)	STRING		Name des Regelelements, dessen Wert zu lesen ist	20030815
4	Importing	IM_REFERENCE	Value transfer	☐	Type reference (TYPE)	STRING		Aktenzeichen, aus dem ein Teilergebnis zu lesen ist	20030815
5	Importing	IM_RULE_NAME	Value transfer	☐	Type reference (TYPE)	STRING		Name der Regel mit der das Aktenzeichen generiert wurde	20030815
6	Importing	IM_RULE_TYPE	Value transfer	☐	Type reference (TYPE)	STRING		Typ der Regel mit der das Aktenzeichen generiert wurde	20030815

Method GET_VALUE_FROM_REFERENCE on Interface IF_SRM_REFERENCE has no exception.

Method PRESET_ELEMENT_VALUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ELEMENT_NAME	Value transfer	☐	Type reference (TYPE)	STRING		Name des vorzubelegenden Elements	20020925
2	Importing	ELEMENT_VALUE	Value transfer	☐	Type reference (TYPE)	STRING		Vorzubelegender Wert des Elements	20020925
3	Importing	ENVIRONMENT	Value transfer	☐	Object reference (TYPE REF TO)	CL_SRM_RF_VALUE_SET		Umgebung (anschl. mit Vorbelegung zum Generieren verwendbar)	20020925
4	Importing	RESULT_NUMBER	Value transfer	☐	Type reference (TYPE)	N	SRMRG_RNUM_RESULT_STRING	Ergebniskennung des Werts (s. Konst. SRMRG_RNUM_*)	20020925
5	Importing	RULE_NAME	Value transfer	☐	Type reference (TYPE)	STRING		Regelname	20020925
6	Importing	RULE_TYPE	Value transfer	☐	Type reference (TYPE)	STRING		Regeltyp	20020925
7	Importing	THROW_EXCEPTION	Value transfer	☐	Type reference (TYPE)	SRMRF_BOOLEAN	SRMRF_FALSE	Exception werfen, wenn Regelelement nicht in Regel?	20020925

Method PRESET_ELEMENT_VALUE on Interface IF_SRM_REFERENCE has no exception.

Method REMOVE_REFERENCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	REFERENCE	Value transfer	☐	Type reference (TYPE)	STRING		Aktenzeichen, dessen Bestandteile zu löschen sind	20020920
2	Importing	RULE_NAME	Value transfer	☐	Type reference (TYPE)	STRING		Name der verwendeten Regel	20020920
3	Importing	RULE_TYPE	Value transfer	☐	Type reference (TYPE)	STRING		Art der verwendeten Regel	20020920

Method REMOVE_REFERENCE on Interface IF_SRM_REFERENCE has no exception.

Method RESERVE_REFERENCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	OK	Value transfer	☐	Type reference (TYPE)	SRMRF_BOOLEAN		Ok, oder ist schon reserviert	20020218
2	Importing	REFERENCE	Value transfer	☐	Type reference (TYPE)	STRING		Aktenzeichen, das reserviert wird	20020117
3	Importing	RULE_NAME	Value transfer	☐	Type reference (TYPE)	STRING		Name der verwendeten Regel	20020117
4	Importing	THROW_EXCEPTION	Value transfer	☐	Type reference (TYPE)	SRMRF_BOOLEAN	SRMRF_FALSE	Falls reserviert: Exception werfen?	20020708
5	Importing	TYPE	Value transfer	☐	Type reference (TYPE)	STRING		Art der verwendeten Regel	20020117

Method RESERVE_REFERENCE on Interface IF_SRM_REFERENCE has no exception.

Method UNRESERVE_REFERENCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	REFERENCE	Value transfer	☐	Type reference (TYPE)	STRING		Aktenzeichen, dessen Reservierung aufgehoben wird	20020614
2	Importing	REMOVE_REFERENCE	Value transfer	☐	Type reference (TYPE)	SRMRF_BOOLEAN	SRMRF_TRUE	Sollen evtl. gespeicherte Bestandteile gelöscht werden?	20020715
3	Importing	RULE_NAME	Value transfer	☐	Type reference (TYPE)	STRING		Name der verwendeten Regel	20020614
4	Importing	TYPE	Value transfer	☐	Type reference (TYPE)	STRING		Art der verwendeten Regel	20020614

Method UNRESERVE_REFERENCE on Interface IF_SRM_REFERENCE has no exception.

History

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