SAP ABAP Class IF_SRM_REFERENCE (Interface for Record Number Generator)
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
| Class | IF_SRM_REFERENCE | |
| Short Description | Interface for Record Number Generator | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | ||
| Created | 20010928 | SAP |
| Last change | 00000000 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) | |
| 2 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Class IF_SRM_REFERENCE has no interface implemented.
Friends
Class IF_SRM_REFERENCE has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Constant | Public | Type reference (TYPE) | STRING | 'REF_OBJECT_TID' | Technical ID of Record Number Owner Object | 20020430 | ||
| 2 | Constant | Private | Type reference (TYPE) | STRING | 'SRM_REF_RULE' | Property Name for RNG Rule | 20020121 | ||
| 3 | Constant | Public | Type reference (TYPE) | STRING | 'CONTAINER_ID' | Rule Element Name for ID of Top Level Object | 20020925 | ||
| 4 | Constant | Public | Type reference (TYPE) | STRING | SRMRG_RULENAME_SEPARATOR | Separator for Transfer of Multiple Rule Names | 20020708 | ||
| 5 | Constant | Public | Type reference (TYPE) | STRING | 'CAS' | Rule Type: Activity Indicator | 20020807 | ||
| 6 | Constant | Private | Type reference (TYPE) | STRING | 'DOC' | Rule Type: Document Number | 20020117 | ||
| 7 | Constant | Private | Type reference (TYPE) | STRING | 'REC' | Rule Type: Record Number | 20020117 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Method | Check Record Number | 20010928 | |
| 2 | Instance method | Public | Method | Create Record Number | 20010928 | |
| 3 | Instance method | Public | Method | Evaluate a Rule Element (As in Generation) | 20020614 | |
| 4 | Instance method | Public | Method | Gets New Session for Generating Record Numbers | 20030529 | |
| 5 | Instance method | Public | Method | Get Part of a Record Number | 20020724 | |
| 6 | Instance method | Public | Method | Read a Rule Definition | 20020612 | |
| 7 | Instance method | Protected | Method | Get Name of Rule | 20020813 | |
| 8 | Instance method | Public | Method | Gets Value of Rule Element (from Elem. Name) from Rec. No. | 20030815 | |
| 9 | Instance method | Public | Method | Reserve Value for Rule Element with Given Name (Before Gen.) | 20020925 | |
| 10 | Instance method | Public | Method | Deletes Saved Parts of Record Number | 20020920 | |
| 11 | Instance method | Public | Method | Reserve Record Number (if required) | 20010928 | |
| 12 | Instance method | Public | Method | Unreserve Reservation of a Record Number | 20020614 |
Events
Class IF_SRM_REFERENCE has no event.
Types
Class 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 | ENVIRONMENT | Value transfer | Object reference (TYPE REF TO) | CL_SRM_RF_VALUE_SET | Umgebung - zusätzliche Kommunikationsschnittstelle | 20020117 | |||
| 2 | REFERENCE | Value transfer | Type reference (TYPE) | STRING | Zu prüfendes Aktenzeichen | 20020117 | |||
| 3 | REFERENCE_OK | Value transfer | Type reference (TYPE) | SRMRF_BOOLEAN | Das Aktenzeichen ist OK? | 20020117 | |||
| 4 | RULE_NAME | Value transfer | Type reference (TYPE) | STRING | Name der verwendeten Regel | 20020117 | |||
| 5 | RULE_NAME_IN | Value transfer | Type reference (TYPE) | STRING | Vorgegebene(r) Regelname(n) (Trenner RULE_NAME_SEPARATOR) | 20020122 | |||
| 6 | THROW_EXCEPTION | Value transfer | Type reference (TYPE) | SRMRF_BOOLEAN | SRMRF_FALSE | Bei fehlerhaftem Aktenzeichen Exception werfen? | 20020708 | ||
| 7 | TYPE | Value transfer | Type reference (TYPE) | STRING | Regeltyp | 20020117 |
Method CHECK_REFERENCE on class 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 | COMMIT_IF_NECESSARY | Value transfer | Type reference (TYPE) | SRMRF_BOOLEAN | SRMRF_TRUE | Commit ausführen, wenn notwendig? | 20020731 | ||
| 2 | ENVIRONMENT | Value transfer | Object reference (TYPE REF TO) | CL_SRM_RF_VALUE_SET | Umgebung - zusätzliche Kommunikationsschnittstelle | 20020117 | |||
| 3 | REFERENCE | Value transfer | Type reference (TYPE) | STRING | Generiertes Aktenzeichen | 20020117 | |||
| 4 | RULE_NAME | Value transfer | Type reference (TYPE) | STRING | Name der verwendeten Regel | 20020117 | |||
| 5 | RULE_NAME_IN | Value transfer | Type reference (TYPE) | STRING | Vorgegebene(r) Regelname(n) (Trenner RULE_NAME_SEPARATOR) | 20020708 | |||
| 6 | TYPE | Value transfer | Type reference (TYPE) | STRING | Art der zu verwendenden Regel | 20020117 | |||
| 7 | USE_DEFAULTS | Value transfer | Type reference (TYPE) | SRMRF_BOOLEAN | Defaultwerte verwenden? | 20020117 |
Method CREATE_REFERENCE on class 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 | ELEMENT_NAME | Value transfer | Type reference (TYPE) | STRING | Name des auszuwertenden Elements | 20020614 | |||
| 2 | ENVIRONMENT | Value transfer | Object reference (TYPE REF TO) | CL_SRM_RF_VALUE_SET | Umgebung - zusätzliche Kommunikationsschnittstelle | 20020614 | |||
| 3 | RESULT | Value transfer | Type reference (TYPE) | STRING | Ergebnis der Elementauswertung | 20020614 | |||
| 4 | RULE_NAME | Value transfer | Type reference (TYPE) | STRING | Regelname | 20020614 | |||
| 5 | RULE_TYPE | Value transfer | Type reference (TYPE) | STRING | Regeltyp | 20020614 |
Method EVAL_ELEMENT on class 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 | IM_SAVED_REFERENCE | Value transfer | Type reference (TYPE) | SRMRGREFKY | Aktuell gespeichertes Aktenzeichen | 20030529 | |||
| 2 | RE_SESSION | Value transfer | Object reference (TYPE REF TO) | IF_SRM_REFERENCE_SESSION | Neue Session | 20030529 |
Method GET_NEW_REFERENCE_SESSION on class 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 | ENVIRONMENT | Value transfer | Object reference (TYPE REF TO) | CL_SRM_RF_VALUE_SET | Umgebung - zusätzliche Kommunikationsschnittstelle | 20020724 | |||
| 2 | GET_RESULT_TAB_ONLY | Value transfer | Type reference (TYPE) | SRMRF_BOOLEAN | SRMRF_TRUE | Nur Ergebnistabelle ohne Zuordnung zu Regeldefinition lesen? | 20020724 | ||
| 3 | NUM_ELEMS_WITHOUT_PART | Value transfer | Type reference (TYPE) | I | Anzahl der Elemente in Regeldefinition ohne Ergebnis | 20020724 | |||
| 4 | NUM_PARTS_WITHOUT_ELEM | Value transfer | Type reference (TYPE) | I | Anzahl der Bestandteile ohne Element in Regeldefinition | 20020724 | |||
| 5 | REFERENCE | Value transfer | Type reference (TYPE) | STRING | Aktenzeichen, dessen Bestandteile zu lesen sind | 20020724 | |||
| 6 | RESULT_TAB | Value transfer | Type reference (TYPE) | SRMRG_REF_RESULT_TAB | Gespeicherte Ergebnisse der Bestandteile des Aktenzeichens | 20020724 | |||
| 7 | RULE_DEF_TAB | Value transfer | Type reference (TYPE) | SRMRG_RULE_DEF_TAB | Regeldefinition | 20020724 | |||
| 8 | RULE_NAME | Value transfer | Type reference (TYPE) | STRING | Regelname | 20020724 | |||
| 9 | RULE_TYPE | Value transfer | Type reference (TYPE) | STRING | Regeltyp | 20020724 |
Method GET_REFERENCE_PARTS on class 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 | ENVIRONMENT | Value transfer | Object reference (TYPE REF TO) | CL_SRM_RF_VALUE_SET | Umgebung - zusätzliche Kommunikationsschnittstelle | 20020717 | |||
| 2 | RULE_DEFINITION | Call by reference | Type reference (TYPE) | SRMRG_RULE_DEF_TAB | Regeldefinition | 20020612 | |||
| 3 | RULE_NAME | Call by reference | Type reference (TYPE) | STRING | Regelname | 20020612 | |||
| 4 | RULE_TYPE | Call by reference | Type reference (TYPE) | STRING | Regeltyp | 20020612 |
Method GET_RULE_DEFINITION on class 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 | ASK_FOR_RULE_NAME | Value transfer | Type reference (TYPE) | SRMRF_BOOLEAN | Benutzer nach Regelname fragen, falls notwendig? | 20020813 | |||
| 2 | ENVIRONMENT | Value transfer | Object reference (TYPE REF TO) | CL_SRM_RF_VALUE_SET | Umgebung - zusätzliche Kommunikationsschnittstelle | 20020813 | |||
| 3 | RULE_NAME | Value transfer | Type reference (TYPE) | STRING | Resultierender Regelname | 20020813 | |||
| 4 | RULE_NAME_IN | Value transfer | Type reference (TYPE) | STRING | Regelname(n) (getrennt durch SRMRG_ENVNAME_SEPARATOR1) | 20020813 | |||
| 5 | RULE_TYPE | Value transfer | Type reference (TYPE) | STRING | Regeltyp | 20020813 |
Method GET_RULE_NAME on class 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 | EX_VALUE_ADDITIONAL | Value transfer | Type reference (TYPE) | STRING | Ggf. zusätzliches Ergebnis d. Regelelements (z.B. Schl. OU) | 20030815 | |||
| 2 | EX_VALUE_IN_REFERENCE | Value transfer | Type reference (TYPE) | STRING | Wert des Regelelements, der Teil des Aktenzeichens ist | 20030815 | |||
| 3 | IM_ELEMENT_NAME | Value transfer | Type reference (TYPE) | STRING | Name des Regelelements, dessen Wert zu lesen ist | 20030815 | |||
| 4 | IM_REFERENCE | Value transfer | Type reference (TYPE) | STRING | Aktenzeichen, aus dem ein Teilergebnis zu lesen ist | 20030815 | |||
| 5 | IM_RULE_NAME | Value transfer | Type reference (TYPE) | STRING | Name der Regel mit der das Aktenzeichen generiert wurde | 20030815 | |||
| 6 | 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 class 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 | ELEMENT_NAME | Value transfer | Type reference (TYPE) | STRING | Name des vorzubelegenden Elements | 20020925 | |||
| 2 | ELEMENT_VALUE | Value transfer | Type reference (TYPE) | STRING | Vorzubelegender Wert des Elements | 20020925 | |||
| 3 | ENVIRONMENT | Value transfer | Object reference (TYPE REF TO) | CL_SRM_RF_VALUE_SET | Umgebung (anschl. mit Vorbelegung zum Generieren verwendbar) | 20020925 | |||
| 4 | RESULT_NUMBER | Value transfer | Type reference (TYPE) | N | SRMRG_RNUM_RESULT_STRING | Ergebniskennung des Werts (s. Konst. SRMRG_RNUM_*) | 20020925 | ||
| 5 | RULE_NAME | Value transfer | Type reference (TYPE) | STRING | Regelname | 20020925 | |||
| 6 | RULE_TYPE | Value transfer | Type reference (TYPE) | STRING | Regeltyp | 20020925 | |||
| 7 | THROW_EXCEPTION | Value transfer | Type reference (TYPE) | SRMRF_BOOLEAN | SRMRF_FALSE | Exception werfen, wenn Regelelement nicht in Regel? | 20020925 |
Method PRESET_ELEMENT_VALUE on class 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 | REFERENCE | Value transfer | Type reference (TYPE) | STRING | Aktenzeichen, dessen Bestandteile zu löschen sind | 20020920 | |||
| 2 | RULE_NAME | Value transfer | Type reference (TYPE) | STRING | Name der verwendeten Regel | 20020920 | |||
| 3 | RULE_TYPE | Value transfer | Type reference (TYPE) | STRING | Art der verwendeten Regel | 20020920 |
Method REMOVE_REFERENCE on class 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 | OK | Value transfer | Type reference (TYPE) | SRMRF_BOOLEAN | Ok, oder ist schon reserviert | 20020218 | |||
| 2 | REFERENCE | Value transfer | Type reference (TYPE) | STRING | Aktenzeichen, das reserviert wird | 20020117 | |||
| 3 | RULE_NAME | Value transfer | Type reference (TYPE) | STRING | Name der verwendeten Regel | 20020117 | |||
| 4 | THROW_EXCEPTION | Value transfer | Type reference (TYPE) | SRMRF_BOOLEAN | SRMRF_FALSE | Falls reserviert: Exception werfen? | 20020708 | ||
| 5 | TYPE | Value transfer | Type reference (TYPE) | STRING | Art der verwendeten Regel | 20020117 |
Method RESERVE_REFERENCE on class 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 | REFERENCE | Value transfer | Type reference (TYPE) | STRING | Aktenzeichen, dessen Reservierung aufgehoben wird | 20020614 | |||
| 2 | REMOVE_REFERENCE | Value transfer | Type reference (TYPE) | SRMRF_BOOLEAN | SRMRF_TRUE | Sollen evtl. gespeicherte Bestandteile gelöscht werden? | 20020715 | ||
| 3 | RULE_NAME | Value transfer | Type reference (TYPE) | STRING | Name der verwendeten Regel | 20020614 | |||
| 4 | TYPE | Value transfer | Type reference (TYPE) | STRING | Art der verwendeten Regel | 20020614 |
Method UNRESERVE_REFERENCE on class IF_SRM_REFERENCE has no exception.
History
| Last changed by/on | SAP | 00000000 |
| SAP Release Created in |