SAP ABAP Class CL_RCM_STATE (State Enumerator (Tri-Singleton))
Hierarchy
☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-RM (Application Component) SAP Records Management
     ⤷ SRM_FRAMEWORK_WDA_STATE (Package) RM Client Framework: Web Dynpro for ABAP, States
Meta Relationship - Using
# Relationship type Using Short Description Created on
1 Interface implementation (CLASS c. INTERFACES i_ref)  IF_RCM_STATE_WD Web Dynpro Helpers for States 20040928
Properties
Class CL_RCM_STATE  
Short Description State Enumerator (Tri-Singleton)    
Super Class    
Instantiability of a Class 0  Private 
Final    
General Data
Message Class    
Program status     
Category 0   
Package SRM_FRAMEWORK_WDA_STATE   RM Client Framework: Web Dynpro for ABAP, States 
Created 20040825   SAP 
Last change 20060207   SAP 
Shared Memory-enabled    
Fixed point arithmetic    
Unicode checks active    
Forward declarations
# Type group / Object type Type Type Description
1 ABAP Type group use (TYPE-POOLS tp)  Type group use (TYPE-POOLS tp)
Interfaces
# Interface Abstract Final Description Created on
1 IF_RCM_STATE_WD Web Dynpro Helpers for States 20040928
Friends
Class CL_RCM_STATE has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 BACKGROUND Static Attribute Public Object reference (TYPE REF TO) CL_RCM_STATE Background State Singleton 20040825
2 DESCRIPTION Instance attribute Private Type reference (TYPE) CHAR16 Field of length 16 20040825
3 DISPLAY Static Attribute Public Object reference (TYPE REF TO) CL_RCM_STATE Display State Singleton 20040825
4 DISPLAY_TEXT Instance attribute Private Type reference (TYPE) CHAR30 Display Text for State 20040910
5 EDIT Static Attribute Public Object reference (TYPE REF TO) CL_RCM_STATE Edit State Singleton 20040825
6 ICON Instance attribute Private Type reference (TYPE) ICONNAME Name of an Icon 20050223
7 INITIAL Static Attribute Public Object reference (TYPE REF TO) CL_RCM_STATE Initial Object Reference 20050208
8 NEW Static Attribute Public Object reference (TYPE REF TO) CL_RCM_STATE New (Created) State Singleton 20040825
9 TEXT_BACKGROUND Constant Private Type reference (TYPE) CHAR16 'BACKGROUND' Field of length 16 20040825
10 TEXT_DISPLAY Constant Public Type reference (TYPE) CHAR16 'DISPLAY' Returned Fixed Text for get_DESCRIPTION 20040825
11 TEXT_EDIT Constant Private Type reference (TYPE) CHAR16 'EDIT' Returned Fixed Text for get_DESCRIPTION 20040825
12 TEXT_INITIAL Constant Public Type reference (TYPE) STRING 'Einstieg' Descriptive Text for "No Status" 20050221
13 TEXT_NEW Constant Private Type reference (TYPE) CHAR16 'NEW' Field of length 16 20040825
14 TEXT_TRANSIENT Constant Private Type reference (TYPE) CHAR16 'TRANSIENT' Returned Fixed Text for get_DESCRIPTION 20040825
15 TRANSIENT Static Attribute Public Object reference (TYPE REF TO) CL_RCM_STATE Transient State Singleton 20040825
16 VISIBILITY Instance attribute Private Attribute reference (LIKE) IF_WDL_CORE=>VISIBILITY Web Dynpro Visibility 20041026
17 WD_IS_UI_ATT_EDIT_ENABLED Instance attribute Private Type reference (TYPE) ABAP_BOOL 20040928
18 WD_IS_UI_ATT_SAVB_ENABLED Instance attribute Private Type reference (TYPE) ABAP_BOOL 20040928
Methods
# Method Level Visibility Method type Description Created on
1 CLASS_CONSTRUCTOR Static method Public Constructor Private (Initialization) 20040825
2 CONSTRUCTOR Instance method Private Constructor Private 20040825
3 GET_DESCRIPTION Instance method Public Method Returns Text Informing Which State Object is Affected 20040825
4 GET_DISPLAY_TEXT Instance method Public Method Returns State text for Screen Display 20040910
5 GET_ICON Instance method Public Method Returns the Icon for this Status 20050223
6 GET_INT_BY_STATE Static method Public Method State Object for ID from Database 20050330
7 GET_STATE_BY_INT Static method Public Method State Object for ID from Database 20040908
Events
Class CL_RCM_STATE has no event.
Types
Class CL_RCM_STATE has no local type.
Method Signatures

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class CL_RCM_STATE has no parameter.
Method CLASS_CONSTRUCTOR on class CL_RCM_STATE has no exception.

Method CONSTRUCTOR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IN_DESCR Call by reference Type reference (TYPE) CHAR16 Feld der Länge 16 20040825
2 Importing IN_DISPLAY_TEXT Call by reference Type reference (TYPE) CHAR30 30 Characters 20040910
3 Importing IN_ICONNAME Call by reference Type reference (TYPE) ICONNAME Name einer Ikone 20050223
4 Importing WD_EDIT Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE 20040928
5 Importing WD_SAVB Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE 20040928

Method CONSTRUCTOR on class CL_RCM_STATE has no exception.

Method GET_DESCRIPTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RE_DESCRIPTION Value transfer Type reference (TYPE) STRING either 'DISPLAY', 'TRANSIENT', 'EDIT', 'NEW' or BACKGROUND' 20040825

Method GET_DESCRIPTION on class CL_RCM_STATE has no exception.

Method GET_DISPLAY_TEXT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RE_DISPLAY_TEXT Value transfer Type reference (TYPE) CHAR30 30 Characters 20040910

Method GET_DISPLAY_TEXT on class CL_RCM_STATE has no exception.

Method GET_ICON Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RE_ICON Value transfer Type reference (TYPE) ICONNAME ICON_**** Format eines Icons 20050223

Method GET_ICON on class CL_RCM_STATE has no exception.

Method GET_INT_BY_STATE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_STATE Value transfer Object reference (TYPE REF TO) CL_RCM_STATE Referenz auf Zustandsobjekt 20050330
2 Returning RE_DB_ID Value transfer Type reference (TYPE) I Zustands-ID (0 bis 5) siehe Klassendokumentation 20050330
# Exception Resumable Description Created on
1 CX_SRM_INITIALIZ_CLFRM Initialisierungsfehler im Client Framework 20050330

Method GET_STATE_BY_INT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_DB_ID Call by reference Type reference (TYPE) I Zustands-ID (0 bis 5) siehe Klassendokumentation 20040908
2 Returning RE_STATE Value transfer Object reference (TYPE REF TO) CL_RCM_STATE Referenz auf Zustandsobjekt 20040908
# Exception Resumable Description Created on
1 CX_SRM_INITIALIZ_CLFRM Initialisierungsfehler im Client Framework 20040908
History
Last changed by/on SAP  20060207 
SAP Release Created in 700