SAP ABAP Class CL_PAK_STATE (Manages the state of a package API object)
Hierarchy
☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-ABA-LA (Application Component) Syntax, Compiler, Runtime
     ⤷ SPAK_WB_FOUNDATION (Package) Framework for integrating the APIs with the ABAP Workbench
Properties
Class CL_PAK_STATE  
Short Description Manages the state of a package API object    
Super Class    
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status     
Category 0   
Package SPAK_WB_FOUNDATION   Framework for integrating the APIs with the ABAP Workbench 
Created 20041026   SAP 
Last change 20071217   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)
2 CL_PAK_DOMAINS Forward declaration class (CLASS c DEFINITION DEFERRED)  Forward declaration class (CLASS c DEFINITION DEFERRED)
3 CL_PAK_WB_DOMAINS Forward declaration class (CLASS c DEFINITION DEFERRED)  Forward declaration class (CLASS c DEFINITION DEFERRED)
Interfaces
Class CL_PAK_STATE has no interface implemented.
Friends
Class CL_PAK_STATE has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 CO_KIND Constant Public See coding 20050301
2 EVENT Instance attribute Private Type reference (TYPE) CL_PAK_WB_DOMAINS=>TY_STATE_EVENT Type for 'CO_OPERATION' attributes 20050307
3 OBJECT Instance attribute Private Type reference (TYPE) PAK_OBJECT_KEY Key of the object whose state is managed 20060601
4 OBJECT_DESCRIPTION Instance attribute Private Type reference (TYPE) STRING Description of the object whose state is managed 20050415
5 PREVIOUS_EVENT Instance attribute Private Type reference (TYPE) CL_PAK_WB_DOMAINS=>TY_STATE_EVENT Previous transition 20050307
6 PREVIOUS_STATE Instance attribute Private Type reference (TYPE) CL_PAK_WB_DOMAINS=>TY_STATE Previous state 20041203
7 STATE Instance attribute Private Type reference (TYPE) CL_PAK_WB_DOMAINS=>TY_STATE Current state of the object 20041026
8 STATES_DELETED Static Attribute Private Type reference (TYPE) TY_STATE_RANGE All states indicating that the object is deleted 20041028
9 STATES_DELETED_ON_DB Static Attribute Private Type reference (TYPE) TY_STATE_RANGE All states indicating that the object is deleted in the DB 20041028
10 STATES_LOCKED Static Attribute Private Type reference (TYPE) TY_STATE_RANGE All states indicating that the object is locked 20041028
11 STATES_MODIFIED Static Attribute Private Type reference (TYPE) TY_STATE_RANGE All states indicating that the object is modified 20041028
12 STATES_NEW Static Attribute Private Type reference (TYPE) TY_STATE_RANGE All states indicating that the object is new 20041028
13 STATES_REVERTED Static Attribute Private Type reference (TYPE) TY_STATE_RANGE All states indicating that the object is reverted 20050810
14 STATE_RULES Static Attribute Private Type reference (TYPE) TY_STATE_RULES Contains all state rules 20041026
Methods
# Method Level Visibility Method type Description Created on
1 CHANGE_STATE Instance method Public Method Changes actual persistence status. 20041026
2 CHECK_STATE_CHANGE Instance method Public Method Checks if requested status change is possible or not. 20041027
3 CLASS_CONSTRUCTOR Static method Public Constructor CLASS_CONSTRUCTOR 20041110
4 CONSTRUCTOR Instance method Public Constructor 20041026
5 GET_EVENT Instance method Public Method 20050307
6 GET_STATE Instance method Public Method Returns the current state 20041221
7 INITIALIZE Instance method Public Method Resets the state machine to its initial state 20050518
8 IS_DELETED Instance method Public Method Returns whether object is deleted 20041028
9 IS_DELETED_ON_DB Instance method Public Method Returns whether object is deleted on DB 20041028
10 IS_LOCKED Instance method Public Method Returns whether object is locked 20041028
11 IS_MODIFIED Instance method Public Method Returns whether object is modified 20041028
12 IS_NEW Instance method Public Method Returns whether object is new 20041028
13 IS_REVERTED_TO_ACTIVE_VERSION Instance method Public Method Returns whether object has been reverted to active version 20050810
14 SET_OBJECT Instance method Public Method Sets a description of the object whose state is managed 20060601
Events
# Event Type Visibility Description Created on
1 STATE_CHANGED Instance Event
(0) 		Public
(2) 		20041203
Types
# Type Visibility Typing Associated Type Description Created on Type Source
1 TY_KIND Public Type reference (TYPE) I 20050301
2 TY_STATE_RANGE Private See coding Range for state rules (internal table) 20041028 ty_state_range type standard table of ty_state_range_struc
3 TY_STATE_RANGE_STRUC Private See coding Range for state rules (structure) 20041028 begin of TY_STATE_RANGE_struc, sign type c length 1, option type c length 2, low type cl_pak_wb_domains=>ty_state, high type cl_pak_wb_domains=>ty_state, end of ty_state_range_struc
4 TY_STATE_RULE Public See coding Structure for a single state rule 20041026 BEGIN OF ty_state_rule, old_state TYPE cl_pak_wb_domains=>ty_state, event TYPE cl_pak_wb_domains=>ty_state_event, new_state TYPE cl_pak_wb_domains=>ty_state, textid TYPE string, END OF ty_state_rule
5 TY_STATE_RULES Public See coding Internal table for state rules 20041026 ty_state_rules TYPE HASHED TABLE OF ty_state_rule WITH UNIQUE KEY old_state event
6 TY_STATE_TEXT Public See coding 20050202 ty_state_text TYPE c LENGTH 60
Method Signatures

Method CHANGE_STATE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_EVENT Call by reference Type reference (TYPE) CL_PAK_WB_DOMAINS=>TY_STATE_EVENT For valid values q.v. constant CO_TRANSITION 20050307
# Exception Resumable Description Created on
1 CX_PAK_INVALID_STATE 20060601

Method CHECK_STATE_CHANGE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_EVENT Call by reference Type reference (TYPE) CL_PAK_WB_DOMAINS=>TY_STATE_EVENT 20050307
# Exception Resumable Description Created on
1 CX_PAK_INVALID_STATE 20060601

Method CLASS_CONSTRUCTOR Signature

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

Method CONSTRUCTOR Signature

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

Method GET_EVENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_KIND Call by reference Type reference (TYPE) TY_KIND CO_KIND-CURRENT 20050307
2 Returning RE_EVENT Value transfer Type reference (TYPE) CL_PAK_WB_DOMAINS=>TY_STATE_EVENT Type for 'CO_TRANSITION' attributes 20050307

Method GET_EVENT on class CL_PAK_STATE has no exception.

Method GET_STATE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_KIND Call by reference Type reference (TYPE) TY_KIND CO_KIND-CURRENT 20050301
2 Returning RE_STATE Value transfer Type reference (TYPE) CL_PAK_WB_DOMAINS=>TY_STATE cl_pak_domains=>co_state 20041221

Method GET_STATE on class CL_PAK_STATE has no exception.

Method INITIALIZE Signature

Method INITIALIZE on class CL_PAK_STATE has no parameter.
Method INITIALIZE on class CL_PAK_STATE has no exception.

Method IS_DELETED Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RE_DELETED Value transfer Type reference (TYPE) ABAP_BOOL 20041028

Method IS_DELETED on class CL_PAK_STATE has no exception.

Method IS_DELETED_ON_DB Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RE_DELETED_ON_DB Value transfer Type reference (TYPE) ABAP_BOOL 20041028

Method IS_DELETED_ON_DB on class CL_PAK_STATE has no exception.

Method IS_LOCKED Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RE_LOCKED Value transfer Type reference (TYPE) ABAP_BOOL 20041028

Method IS_LOCKED on class CL_PAK_STATE has no exception.

Method IS_MODIFIED Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RE_MODIFIED Value transfer Type reference (TYPE) ABAP_BOOL 20041028

Method IS_MODIFIED on class CL_PAK_STATE has no exception.

Method IS_NEW Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RE_NEW Value transfer Type reference (TYPE) ABAP_BOOL 20041028

Method IS_NEW on class CL_PAK_STATE has no exception.

Method IS_REVERTED_TO_ACTIVE_VERSION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RE_REVERTED_TO_ACTIVE_VERSION Value transfer Type reference (TYPE) ABAP_BOOL 20050810

Method IS_REVERTED_TO_ACTIVE_VERSION on class CL_PAK_STATE has no exception.

Method SET_OBJECT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_OBJECT Call by reference Type reference (TYPE) PAK_OBJECT_KEY Key of the object 20060601
2 Importing IM_OBJECT_DESCRIPTION Call by reference Type reference (TYPE) STRING The object's description 20060601

Method SET_OBJECT on class CL_PAK_STATE has no exception.
Event Signatures

Event STATE_CHANGED Signature
# Parameter Type Pass Value Optional Typing Method Associated Type Default value Description Created on
1 EX_EVENT Exporting Value transfer Type reference (TYPE) CL_PAK_WB_DOMAINS=>TY_STATE_EVENT 20050307
2 EX_PREVIOUS_STATE Exporting Value transfer Type reference (TYPE) CL_PAK_WB_DOMAINS=>TY_STATE Type for 'CO_STATE' attributes 20050307
3 EX_STATE Exporting Value transfer Type reference (TYPE) CL_PAK_WB_DOMAINS=>TY_STATE Type for 'CO_STATE' attributes 20050302
History
Last changed by/on SAP  20071217 
SAP Release Created in 710