SAP ABAP Interface IF_PAK_WB_OBJECT (Groups common properties of Workbench-related objects)
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
Meta Relationship - Used By
# Relationship type Used by Short Description Created on
1 Interface composition (i COMPRISING i_ref)  IF_CLS_ATTRIBUTE Attribute 20050511
2 Interface composition (i COMPRISING i_ref)  IF_CLS_ATTR_VALUE_ASSIGNMENT Attribute value assignment 20050601
3 Interface composition (i COMPRISING i_ref)  IF_CLS_OBJECT_TYPE_GROUP Object type group 20050420
4 Interface composition (i COMPRISING i_ref)  IF_CLS_REPORT_DEF Definition of calssificationsreport 20050901
5 Interface composition (i COMPRISING i_ref)  IF_PAK_WB_OBJECT_INTERNAL Interface for internal access to an IF_PAK_WB_OBJECT 20050509
6 Interface composition (i COMPRISING i_ref)  IF_SFW_WB_BFSET WB - Business Function Set 20080103
7 Interface composition (i COMPRISING i_ref)  IF_SFW_WB_BFUNC WB - Business Function Set 20080103
8 Interface composition (i COMPRISING i_ref)  IF_SFW_WB_SWITCH 20080102
9 Interface implementation (CLASS c. INTERFACES i_ref)  CL_PAK_WB_OBJECT Implementation of Workbench-related behaviour 20050414
Properties
Interface IF_PAK_WB_OBJECT  
Short Description Groups common properties of Workbench-related objects    
General Data
Package SPAK_WB_FOUNDATION   Framework for integrating the APIs with the ABAP Workbench 
Created 20041014   SAP 
Last changed 20071217   SAP 
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_STATE 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
Interface IF_PAK_WB_OBJECT has no interface.
Friends
Interface IF_PAK_WB_OBJECT has no friend.
Attributes
Interface IF_PAK_WB_OBJECT has no attribute.
Methods
# Method Level Visibility Method type Description Created on
1 ACTIVATE Instance method Public Method Activates the object 20050420
2 CHECK_CONSISTENCY Instance method Public Method Raises an exception if the object is not consistent 20050419
3 DELETE Instance method Public Method Deletes the object 20050420
4 DESCRIBE Instance method Public Method Returns a description of the object (for error messages) 20050506
5 EXISTS Instance method Public Method Returns whether an act. or inact. version exists on the DB 20050418
6 EXISTS_OWN_INACTIVE_VERSION Instance method Public Method Returns whether the object is in the current user's worklist 20050511
7 GET_ACTIVATION_STATE Instance method Public Method Returns the activation state of this version of the object 20050414
8 GET_CREATED Instance method Public Method Returns author and date of the object's creation 20050420
9 GET_CTS_IDENTIFIER Instance method Public Method Returns the object's identifier for the transport system 20051229
10 GET_LAST_CHANGED Instance method Public Method Returns author and date of the object's last modification 20050420
11 GET_MASTER_LANGUAGE Instance method Public Method Returns the language in which the object is maintained 20050512
12 GET_ORIGINAL_SYSTEM Instance method Public Method Returns in which system the object's original resides 20050512
13 GET_PACKAGE Instance method Public Method Returns the package in which the object is contained 20050512
14 GET_PAK_OBJECT_KEY Instance method Public Method Returns the PAK_OBJECT_KEY corresponding to this object 20060531
15 GET_PERSON_RESPONSIBLE Instance method Public Method Returns the user that is responsible for this object 20050512
16 GET_STATE_TEXT Instance method Public Method Describes the current state of the object 20050414
17 GET_WBM_IDENTIFIER Instance method Public Method Returns the object's identifier for the workbench manager 20050512
18 HAS_OBJECT_DIRECTORY_INFO Instance method Public Method Returns whether there's a corresponding object catalog entry 20051229
19 IS_DELETED_ON_DB Instance method Public Method Returns whether the object is deleted on the DB 20050503
20 IS_LOCKED Instance method Public Method Returns whether enqueue locks have been obtained 20050419
21 IS_MODIFIED Instance method Public Method Returns whether there are unsaved changes 20050419
22 IS_NEW Instance method Public Method Returns whether an object is new 20050608
23 LOCK_AND_REFRESH Instance method Public Method Locks the object against concurrent changes and refreshes it 20050419
24 REFRESH Instance method Public Method Refreshes the object, that is, re-reads all data from the DB 20050418
25 REVERT_TO_ACTIVE_VERSION Instance method Public Method Discards the inactive version of the object 20050810
26 SAVE Instance method Public Method Saves changed data to the DB 20050419
27 UNLOCK Instance method Public Method Releases the object's lock against concurrent changes 20050419
Events
# Event Type Visibility Description Created on
1 ACTIVATION_STATE_CHANGING Instance Event
(0) 		Public
(2) 		Raised before the activation state changes 20050414
Types
Interface IF_PAK_WB_OBJECT has no local type.
Method Signatures

Method ACTIVATE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_ACTIVATE_DESPITE_OF_ERRORS Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE ABAP_FALSE to activate only if the object is consistent 20050810
2 Importing IM_RAISE_MESSAGES_OF_TYPE Call by reference Type reference (TYPE) PAK_MESSAGE_TYPE CL_PAK_WB_DOMAINS=>CO_MESSAGE_TYPE-ERROR Which type of message to raise as exceptions 20060518
# Exception Resumable Description Created on
1 CX_PAK_INVALID_DATA Invalid data 20050420
2 CX_PAK_INVALID_STATE Method can not be executed at present object state 20050420
3 CX_PAK_NOT_AUTHORIZED User does not have the right privileges 20050420

Method CHECK_CONSISTENCY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_CHECK_MODE Call by reference Type reference (TYPE) CL_PAK_WB_DOMAINS=>TY_CHECK_MODE CL_PAK_WB_DOMAINS=>CO_CHECK_MODE-ACTIVATE Specifies the subset of checks to execute 20050419
2 Importing IM_RAISE_MESSAGES_OF_TYPE Call by reference Type reference (TYPE) PAK_MESSAGE_TYPE CL_PAK_WB_DOMAINS=>CO_MESSAGE_TYPE-ERROR Which type of message to raise as exceptions 20060519
# Exception Resumable Description Created on
1 CX_PAK_INVALID_DATA Invalid data 20050419
2 CX_PAK_INVALID_STATE Method can not be executed at present object state 20050419

Method DELETE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_RAISE_MESSAGES_OF_TYPE Call by reference Type reference (TYPE) PAK_MESSAGE_TYPE CL_PAK_WB_DOMAINS=>CO_MESSAGE_TYPE-ERROR Whether to raise also warning or even info messages 20060607
# Exception Resumable Description Created on
1 CX_PAK_INVALID_DATA Invalid package data 20050420
2 CX_PAK_INVALID_STATE Method can not be executed at present object state 20050420
3 CX_PAK_NOT_AUTHORIZED User does not have the right privileges 20050420

Method DESCRIBE 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 The text identifying the object to the user 20050506

Method DESCRIBE on Interface IF_PAK_WB_OBJECT has no exception.

Method EXISTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_ACTIVE_VERSION Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE ABAP_TRUE to check whether active version exists 20050418
2 Importing IM_INACTIVE_VERSION Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE ABAP_TRUE to check whether inactive version exists 20050418
3 Returning RE_EXISTS Value transfer Type reference (TYPE) ABAP_BOOL ABAP_TRUE if the requested version exists 20050418

Method EXISTS on Interface IF_PAK_WB_OBJECT has no exception.

Method EXISTS_OWN_INACTIVE_VERSION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RE_EXISTS_OWN_INACTIVE_VERSION Value transfer Type reference (TYPE) ABAP_BOOL ABAP_TRUE if there's an inactive version of the current user 20050511

Method EXISTS_OWN_INACTIVE_VERSION on Interface IF_PAK_WB_OBJECT has no exception.

Method GET_ACTIVATION_STATE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RE_ACTIVATION_STATE Value transfer Type reference (TYPE) PAK_ACTIVATION_STATE Activation state for package data 20050414
# Exception Resumable Description Created on
1 CX_PAK_INVALID_STATE Method can not be executed at present object state 20050414

Method GET_CREATED Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EX_CREATED_BY Call by reference Type reference (TYPE) EU_AUTOR Author of the object's creation 20050420
2 Exporting EX_CREATED_ON Call by reference Type reference (TYPE) EU_DATUM Created on 20050420
# Exception Resumable Description Created on
1 CX_PAK_INVALID_STATE Method can not be executed at present object state 20050420

Method GET_CTS_IDENTIFIER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EX_OBJECT_NAME Call by reference Type reference (TYPE) STRING The "technical" name of the object 20051229
2 Exporting EX_OBJECT_TYPE Call by reference Type reference (TYPE) TROBJTYPE The code identifying the object type 20051229

Method GET_CTS_IDENTIFIER on Interface IF_PAK_WB_OBJECT has no exception.

Method GET_LAST_CHANGED Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EX_CHANGED_BY Call by reference Type reference (TYPE) EU_VAUTOR Last changed by 20050420
2 Exporting EX_CHANGED_ON Call by reference Type reference (TYPE) EU_VDATUM Last changed on 20050420
# Exception Resumable Description Created on
1 CX_PAK_INVALID_STATE Method can not be executed at present object state 20050420

Method GET_MASTER_LANGUAGE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RE_MASTER_LANGUAGE Value transfer Type reference (TYPE) SYLANGU Language key for the object's "original" language 20050512
# Exception Resumable Description Created on
1 CX_PAK_OBJECT Method can not be executed at present object state 20060602

Method GET_ORIGINAL_SYSTEM Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RE_ORIGINAL_SYSTEM Value transfer Type reference (TYPE) SRCSYSTEM Original System of Object 20050512
# Exception Resumable Description Created on
1 CX_PAK_OBJECT Errors related to package-assigned objects 20060602

Method GET_PACKAGE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RE_PACKAGE Value transfer Type reference (TYPE) DEVCLASS Package 20050512
# Exception Resumable Description Created on
1 CX_PAK_OBJECT Method can not be executed at present object state 20060602

Method GET_PAK_OBJECT_KEY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EX_PAK_OBJECT_KEY Call by reference Type reference (TYPE) PAK_OBJECT_KEY Object key of this object 20060531

Method GET_PAK_OBJECT_KEY on Interface IF_PAK_WB_OBJECT has no exception.

Method GET_PERSON_RESPONSIBLE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RE_PERSON_RESPONSIBLE Value transfer Type reference (TYPE) RESPONSIBL User name of the person responsible for the object 20050512
# Exception Resumable Description Created on
1 CX_PAK_OBJECT Method can not be executed at present object state 20060602

Method GET_STATE_TEXT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RE_STATE_TEXT Value transfer Type reference (TYPE) STRING 20050414

Method GET_STATE_TEXT on Interface IF_PAK_WB_OBJECT has no exception.

Method GET_WBM_IDENTIFIER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EX_WBM_NAME Call by reference Type reference (TYPE) STRING 20050512
2 Exporting EX_WBM_TYPE Call by reference Type reference (TYPE) SEU_OBJTYP WB Request: Type of Object of Development Environment 20050512

Method GET_WBM_IDENTIFIER on Interface IF_PAK_WB_OBJECT has no exception.

Method HAS_OBJECT_DIRECTORY_INFO Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RE_HAS_OBJECT_DIRECTORY_INFO Value transfer Type reference (TYPE) ABAP_BOOL ABAP_FALSE if there's no object catalog entry for the object 20051229

Method HAS_OBJECT_DIRECTORY_INFO on Interface IF_PAK_WB_OBJECT 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_IS_DELETED Value transfer Type reference (TYPE) ABAP_BOOL 20050503

Method IS_DELETED_ON_DB on Interface IF_PAK_WB_OBJECT has no exception.

Method IS_LOCKED Signature

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

Method IS_LOCKED on Interface IF_PAK_WB_OBJECT has no exception.

Method IS_MODIFIED Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RE_IS_MODIFIED Value transfer Type reference (TYPE) ABAP_BOOL package is modified 20050419

Method IS_MODIFIED on Interface IF_PAK_WB_OBJECT has no exception.

Method IS_NEW Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RE_IS_NEW Value transfer Type reference (TYPE) ABAP_BOOL package is modified 20050608

Method IS_NEW on Interface IF_PAK_WB_OBJECT has no exception.

Method LOCK_AND_REFRESH Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_ALLOW_POPUPS Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE ABAP_FALSE to suppress any pop-ups etc. 20060511
2 Importing IM_RAISE_MESSAGES_OF_TYPE Call by reference Type reference (TYPE) PAK_MESSAGE_TYPE CL_PAK_WB_DOMAINS=>CO_MESSAGE_TYPE-ERROR Whether also warnings or even info messages should be raised 20060824
# Exception Resumable Description Created on
1 CX_PAK_INVALID_DATA Invalid package data 20050419
2 CX_PAK_INVALID_STATE Method can not be executed at present object state 20050419
3 CX_PAK_NOT_AUTHORIZED User does not have the right privileges 20050419
4 CX_PAK_WB_OBJECT_LOCKED Error situation: enqueue locks hold by other instance 20060519

Method REFRESH Signature

Method REFRESH on Interface IF_PAK_WB_OBJECT has no parameter.
# Exception Resumable Description Created on
1 CX_PAK_INVALID_STATE Method can not be executed at present object state 20050418

Method REVERT_TO_ACTIVE_VERSION Signature

Method REVERT_TO_ACTIVE_VERSION on Interface IF_PAK_WB_OBJECT has no parameter.
# Exception Resumable Description Created on
1 CX_PAK_INVALID_STATE Operation can't be executed in present object state 20050810

Method SAVE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CH_TRANSPORT_REQUEST Call by reference Type reference (TYPE) TRKORR Request/Task 20050419
2 Importing IM_ALLOW_POPUPS Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE ABAP_FALSE to suppress any pop-ups etc. 20060511
# Exception Resumable Description Created on
1 CX_PAK_ACTION_CANCELLED Error situation where the user cancelled an operation 20060518
2 CX_PAK_INVALID_DATA Invalid data 20050419
3 CX_PAK_INVALID_STATE Method can not be executed at present object state 20050419
4 CX_PAK_NOT_AUTHORIZED User does not have the right privileges 20050419

Method UNLOCK Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IM_WAIT_UNTIL_UNLOCKED Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE ABAP_FALSE to unlock asynchronously 20051019
# Exception Resumable Description Created on
1 CX_PAK_INVALID_STATE Method can not be executed at present object state 20050419
Event Signatures

Event ACTIVATION_STATE_CHANGING Signature
# Parameter Type Pass Value Optional Typing Method Associated Type Default value Description Created on
1 EX_ACTIVATION_STATE Exporting Value transfer Type reference (TYPE) PAK_ACTIVATION_STATE Future activation state 20050414
History
Last changed by/on SAP  20071217 
SAP Release Created in 710