SAP ABAP Class CL_SRM_START_FRAMEWORK (Start of the SRM Framework)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-SRV-RM (Application Component) SAP Records Management
⤷
SRM_CLIENTFRAME_WIN (Package) Records Management: Wingui Client Framework
SAP_BASIS (Software Component) SAP Basis Component⤷
BC-SRV-RM (Application Component) SAP Records Management⤷
SRM_CLIENTFRAME_WIN (Package) Records Management: Wingui Client FrameworkMeta Relationship - Using
| # | Relationship type | Using | Short Description | Created on |
|---|---|---|---|---|
| 1 | Inheritance (c INHERITING FROM c_ref) | CL_SRM | SRM Basis Class (abstract) | 20001018 |
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Inheritance (c INHERITING FROM c_ref) | CL_SRM_BSP_START_FRAMEWORK | Start of SRM BSP Client Framework | 20011127 |
Properties
| Class | CL_SRM_START_FRAMEWORK | |
| Short Description | Start of the SRM Framework | |
| Super Class | CL_SRM | SRM Basis Class (abstract) |
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | SRM_CLIENTFRAME_WIN | Records Management: Wingui Client Framework |
| Created | 20001017 | SAP |
| Last change | 20130531 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 |  CL_SRM_ROOT_FACTORY |
Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) |
| 2 | CL_SRM_START_FRAMEWORK |
Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) |
| 3 | SRMCF |
Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
| 4 | SRMCL |
Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
| 5 | SRMIF |
Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Class CL_SRM_START_FRAMEWORK has no interface implemented.
Friends
Class CL_SRM_START_FRAMEWORK has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ACTIVITY |
Instance attribute | Protected | Type reference (TYPE) | SRMIF_SP_ACTIVITY | POID Reference | 20010327 | ||
| 2 | CFW_SPS_ID |
Instance attribute | Protected | Type reference (TYPE) | STRING | SPS ID of the Client Framework | 20020702 | ||
| 3 | MODEL_DATA_SET |
Instance attribute | Protected | Type reference (TYPE) | SRMBOOLEAN | Model Data Is Set | 20001017 | ||
| 4 | MY_CLIENTMANAGER |
Instance attribute | Protected | Object reference (TYPE REF TO) | IF_SRM_CLIENTMANAGER | My clientmanager | 20001103 | ||
| 5 | MY_ROOT |
Instance attribute | Protected | Object reference (TYPE REF TO) | IF_SRM_ROOT | My Root | 20001106 | ||
| 6 | MY_SERVICE_OBJECT |
Instance attribute | Protected | Object reference (TYPE REF TO) | IF_SRM_SRM_SERVICE | RMF service object | 20010326 | ||
| 7 | POID_REF |
Instance attribute | Protected | Object reference (TYPE REF TO) | IF_SRM_POID | POID Reference | 20010327 | ||
| 8 | RESULT_ACTIVITY_STATE |
Instance attribute | Protected | Type reference (TYPE) | I | Results Status | 20010906 | ||
| 9 | RESULT_POID |
Instance attribute | Protected | Object reference (TYPE REF TO) | IF_SRM_POID | Result | 20010906 | ||
| 10 | UPDATE_MODE_POID_DIRECTORY |
Instance attribute | Protected | Type reference (TYPE) | STRING | Update Mode for POID Directory | 20011008 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CHECK_ACTIVITY |
Instance method | Protected | Method | checks whether activity is allowed | 20010326 |
| 2 | CHECK_CLIENTMANAGER |
Instance method | Protected | Method | check whether client manager is active, instanciate if not | 20010326 |
| 3 | CHECK_ROOT_OBJECT |
Instance method | Protected | Method | checks whether root object exists (instanciate if not) | 20010326 |
| 4 | CHECK_SERVICE_OBJECT |
Instance method | Protected | Method | checks whether service object exists, instanciate it if not | 20010326 |
| 5 | CONSTRUCTOR |
Instance method | Public | Constructor | Constructor | 20011008 |
| 6 | GET_ACTIVITY |
Instance method | Public | Method | Gets Activity | 20010710 |
| 7 | GET_DATA_TYPE |
Instance method | Public | Method | Get the data type | 20001017 |
| 8 | GET_DEFAULT_ACTIVITY |
Instance method | Protected | Method | gets default activity for item | 20010326 |
| 9 | GET_DIRECTORY_POID |
Instance method | Protected | Method | get poid from directory | 20010326 |
| 10 | GET_POID |
Instance method | Public | Method | get poid data | 20010710 |
| 11 | GET_REFERENCE_POID |
Instance method | Protected | Method | gets reference poid for sps id (and sp poid) | 20010326 |
| 12 | GET_RESULT_ACTIVITY_STATE |
Instance method | Public | Method | Gets Result Status After Executed Operation | 20010906 |
| 13 | GET_RESULT_POID |
Instance method | Public | Method | Gets Result After Executed Operation | 20010906 |
| 14 | GET_SRM |
Instance method | Public | Method | Returns Reference to IF_SRM | 20011030 |
| 15 | GET_SRM_ROOT |
Instance method | Public | Method | Returns Reference to IF_SRM_ROOT | 20011030 |
| 16 | GET_SRM_SERVICE |
Instance method | Public | Method | Returns Reference to Service Object (Eg. Sets Context) | 20011017 |
| 17 | SET_INSTANCE_DATA |
Instance method | Public | Method | Setting Start Element (Instance POID) | 20001017 |
| 18 | SET_MODEL_DATA |
Instance method | Public | Method | Setting Start Element (Model POID) | 20001017 |
| 19 | SET_REFERENCE_POID |
Instance method | Public | Method | Setting the Start Reference Directly with the POID Object | 20011211 |
| 20 | START |
Instance method | Public | Method | Visual Start of Records Management Framework | 20001018 |
Events
Class CL_SRM_START_FRAMEWORK has no event.
Types
Class CL_SRM_START_FRAMEWORK has no local type.
Method Signatures
Method CHECK_ACTIVITY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
ACTIVITY | Value transfer | Type reference (TYPE) | SRMIF_SP_ACTIVITY | Aktivität | 20010326 | ||
| 2 |  Returning |
ACTIVITY_SUPPORTED | Value transfer | Type reference (TYPE) | SRMBOOLEAN | Boolean: Mögliche Werte IF_SRM_OBJECT=>TRUE / FALSE | 20010710 | ||
| 3 | Importing |
POID_REF | Value transfer | Object reference (TYPE REF TO) | IF_SRM_POID | reference poid | 20010327 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_SRM_ACTIVITY |
Aktivitäten (abstrakt) | 20010720 | |
| 2 | CX_SRM_INITIALIZATION |
Initialisierungsfehler (abstrakt) | 20010710 | |
| 3 | CX_SRM_NO_AUTHORIZATION |
Fehlende Berechtigung | 20010710 | |
| 4 | CX_SRM_POID |
POID Fehler (abstrakt) | 20010720 | |
| 5 | CX_SRM_REGISTRATION_DATA |
Fehler Registrierungsdaten (abstrakt) | 20010710 |
Method CHECK_CLIENTMANAGER Signature
Method CHECK_CLIENTMANAGER on class CL_SRM_START_FRAMEWORK has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRM_INITIALIZATION |
Initialisierungsfehler (abstrakt) | 20010710 | |
| 2 | CX_SRM_REGISTRATION_DATA |
Fehler Registrierungsdaten (abstrakt) | 20010710 |
Method CHECK_ROOT_OBJECT Signature
Method CHECK_ROOT_OBJECT on class CL_SRM_START_FRAMEWORK has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRM_INITIALIZATION |
Initialisierungsfehler (abstrakt) | 20010710 | |
| 2 | CX_SRM_REGISTRATION_DATA |
Fehler Registrierungsdaten (abstrakt) | 20010719 |
Method CHECK_SERVICE_OBJECT Signature
Method CHECK_SERVICE_OBJECT on class CL_SRM_START_FRAMEWORK has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRM_INITIALIZATION |
Initialisierungsfehler (abstrakt) | 20010710 | |
| 2 | CX_SRM_REGISTRATION_DATA |
Fehler Registrierungsdaten (abstrakt) | 20010719 |
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IM_CLIENTFRAME_SPS_ID | Value transfer | Type reference (TYPE) | SRMSPSID | 'SRM_RMS_CLIENTFRAME_WIN' | SPS ID des Client Framework | 20020702 |
Method CONSTRUCTOR on class CL_SRM_START_FRAMEWORK has no exception.
Method GET_ACTIVITY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
ACTIVITY | Value transfer | Type reference (TYPE) | STRING | Aktivität | 20010710 |
Method GET_ACTIVITY on class CL_SRM_START_FRAMEWORK has no exception.
Method GET_DATA_TYPE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
EX_MODEL_DATA | Value transfer | Type reference (TYPE) | SRMBOOLEAN | true: model data is set, false: instance data is set | 20001017 |
Method GET_DATA_TYPE on class CL_SRM_START_FRAMEWORK has no exception.
Method GET_DEFAULT_ACTIVITY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
DEFAULT_ACTIVITY | Value transfer | Type reference (TYPE) | SRMIF_SP_ACTIVITY | default activity | 20010326 | ||
| 2 | Importing |
POID_REF | Value transfer | Object reference (TYPE REF TO) | IF_SRM_POID | reference poid | 20010327 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRM_ACTIVITY |
Aktivitäten (abstrakt) | 20010720 | |
| 2 | CX_SRM_INITIALIZATION |
Initialisierungsfehler (abstrakt) | 20010710 | |
| 3 | CX_SRM_NO_AUTHORIZATION |
Fehlende Berechtigung | 20010710 | |
| 4 | CX_SRM_POID |
POID Fehler (abstrakt) | 20010720 | |
| 5 | CX_SRM_REGISTRATION_DATA |
Fehler Registrierungsdaten (abstrakt) | 20010710 |
Method GET_DIRECTORY_POID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
AREA_ID | Value transfer | Type reference (TYPE) | STRING | area id | 20010326 | ||
| 2 | Importing |
PDIR_ID | Value transfer | Type reference (TYPE) | STRING | poid id | 20011008 | ||
| 3 | Returning |
POID_REF | Value transfer | Object reference (TYPE REF TO) | IF_SRM_POID | poid reference | 20010327 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRM_INITIALIZATION |
Initialisierungsfehler (abstrakt) | 20010710 | |
| 2 | CX_SRM_POID |
POID Fehler (abstrakt) | 20010710 | |
| 3 | CX_SRM_POID_DIR |
POID Directory | 20010710 | |
| 4 | CX_SRM_REGISTRATION_DATA |
Fehler Registrierungsdaten (abstrakt) | 20010710 |
Method GET_POID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
EX_POID_REF | Value transfer | Object reference (TYPE REF TO) | IF_SRM_POID | reference poid | 20010710 |
Method GET_POID on class CL_SRM_START_FRAMEWORK has no exception.
Method GET_REFERENCE_POID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
MODEL | Value transfer | Type reference (TYPE) | SRMBOOLEAN | Modellpoid erzeugen | 20011204 | ||
| 2 | Returning |
REF_POID | Value transfer | Object reference (TYPE REF TO) | IF_SRM_POID | poid object | 20010326 | ||
| 3 | Importing |
RMS_ID | Value transfer | Type reference (TYPE) | STRING | RMS ID | 20011008 | ||
| 4 | Importing |
SPS_ID | Value transfer | Type reference (TYPE) | STRING | sps id | 20010326 | ||
| 5 | Importing |
SP_POID | Value transfer | Type reference (TYPE) | SRM_LIST_POID | sp poid | 20010326 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRM_INITIALIZATION |
Initialisierungsfehler (abstrakt) | 20010710 | |
| 2 | CX_SRM_POID |
SP POID Fehler | 20010710 | |
| 3 | CX_SRM_REGISTRATION_DATA |
Registrierungsdaten SPS | 20010710 |
Method GET_RESULT_ACTIVITY_STATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RE_RESULT_ACTIVITY_STATE | Value transfer | Type reference (TYPE) | I | 20010906 |
Method GET_RESULT_ACTIVITY_STATE on class CL_SRM_START_FRAMEWORK has no exception.
Method GET_RESULT_POID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RE_RESULT | Value transfer | Object reference (TYPE REF TO) | IF_SRM_POID | POID | 20010906 |
Method GET_RESULT_POID on class CL_SRM_START_FRAMEWORK has no exception.
Method GET_SRM Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RE_SRM | Value transfer | Object reference (TYPE REF TO) | IF_SRM | Referenz auf IF_SRM | 20011030 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRM_INITIALIZATION |
Initialisierungsfehler (abstrakt) | 20011030 | |
| 2 | CX_SRM_REGISTRATION_DATA |
Fehler Registrierungsdaten (abstrakt) | 20011030 |
Method GET_SRM_ROOT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RE_SRM_ROOT | Value transfer | Object reference (TYPE REF TO) | IF_SRM_ROOT | Referenz auf IF_SRM_ROOT | 20011030 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRM_INITIALIZATION |
Initialisierungsfehler (abstrakt) | 20011030 | |
| 2 | CX_SRM_REGISTRATION_DATA |
Fehler Registrierungsdaten (abstrakt) | 20011030 |
Method GET_SRM_SERVICE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RE_SERVICE | Value transfer | Object reference (TYPE REF TO) | IF_SRM_SRM_SERVICE | Service Interface | 20011017 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRM_INITIALIZATION |
Initialisierungsfehler (abstrakt) | 20011017 | |
| 2 | CX_SRM_REGISTRATION_DATA |
Fehler Registrierungsdaten (abstrakt) | 20011017 |
Method SET_INSTANCE_DATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IM_ACTIVITY | Value transfer | Type reference (TYPE) | SRMIF_SP_ACTIVITY | Aktivität | 20001017 | ||
| 2 | Importing |
IM_AREA_ID | Value transfer | Type reference (TYPE) | STRING | 'S_AREA_RMS' | Area-ID | 20021010 | |
| 3 | Importing |
IM_PDIR_ID | Value transfer | Type reference (TYPE) | STRING | PDIR ID | 20011030 | ||
| 4 | Importing |
IM_RMS_ID | Value transfer | Type reference (TYPE) | STRING | RMS ID | 20011008 | ||
| 5 | Importing |
IM_SPS_ID | Value transfer | Type reference (TYPE) | STRING | SPS ID | 20001017 | ||
| 6 | Importing |
IM_SP_POID | Value transfer | Type reference (TYPE) | SRM_LIST_POID | SP POID | 20001017 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRM_ACTIVITY |
Aktivitäten (abstrakt) | 20010720 | |
| 2 | CX_SRM_INITIALIZATION |
Initialisierungsfehler (abstrakt) | 20010710 | |
| 3 | CX_SRM_NO_AUTHORIZATION |
Fehlende Berechtigung | 20010710 | |
| 4 | CX_SRM_POID |
POID Fehler (abstrakt) | 20010710 | |
| 5 | CX_SRM_POID_DIR |
POID Directory | 20010710 | |
| 6 | CX_SRM_REGISTRATION_DATA |
Fehler Registrierungsdaten (abstrakt) | 20010710 |
Method SET_MODEL_DATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IM_ACTIVITY | Value transfer | Type reference (TYPE) | SRMIF_SP_ACTIVITY | Activity | 20001017 | ||
| 2 | Importing |
IM_RMS_ID | Value transfer | Type reference (TYPE) | STRING | RMS ID | 20011008 | ||
| 3 | Importing |
IM_SPS_ID | Value transfer | Type reference (TYPE) | STRING | SPS ID | 20001017 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRM_ACTIVITY |
Aktivitäten (abstrakt) | 20010720 | |
| 2 | CX_SRM_INITIALIZATION |
Initialisierungsfehler (abstrakt) | 20010710 | |
| 3 | CX_SRM_NO_AUTHORIZATION |
Fehlende Berechtigung | 20010710 | |
| 4 | CX_SRM_POID |
POID Fehler (abstrakt) | 20010710 | |
| 5 | CX_SRM_REGISTRATION_DATA |
Fehler Registrierungsdaten (abstrakt) | 20010710 |
Method SET_REFERENCE_POID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IM_ACTIVITY | Value transfer | Type reference (TYPE) | SRMACTID | Aktivität | 20011211 | ||
| 2 | Importing |
IM_POID | Value transfer | Object reference (TYPE REF TO) | IF_SRM_POID | POID Objekt (Startreferenz) | 20011211 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRM_FRAMEWORK |
Framework (abstrakt) | 20011211 | |
| 2 | CX_SRM_NO_AUTHORIZATION |
Fehlende Berechtigung | 20011211 |
Method START Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
OPTION_NAVIGATION | Value transfer | Type reference (TYPE) | SRMBOOLEAN | Option: Mit Navigation | 20010803 | ||
| 2 | Importing |
OPTION_ORGANIZER | Value transfer | Type reference (TYPE) | SRMBOOLEAN | Option: Mit Organizer | 20010803 | ||
| 3 | Importing |
ORGANIZER_RMS_ID | Value transfer | Type reference (TYPE) | STRING | 'S_RMS_DATA' | RMS ID Organizer | 20020702 | |
| 4 | Importing |
ORGANIZER_SPS_ID | Value transfer | Type reference (TYPE) | STRING | 'SRM_SPS_ORGANIZER' | SPS ID Organizer | 20020702 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRM_FRAMEWORK |
Framework (abstrakt) | 20010810 |
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in | 50A |
