SAP ABAP Class IF_POBJ_PROCESS_OBJECT (Process Object Interface)
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_POBJ_PROCESS_OBJECT | Generalized Process Object API | 20060406 |
Properties
| Class | IF_POBJ_PROCESS_OBJECT | |
| Short Description | Process Object Interface | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | ||
| Created | 20060406 | SAP |
| Last change | 20071120 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
Class IF_POBJ_PROCESS_OBJECT has no forward declaration.
Interfaces
Class IF_POBJ_PROCESS_OBJECT has no interface implemented.
Friends
Class IF_POBJ_PROCESS_OBJECT has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CONSUMER_ID |
Instance attribute | Public | Type reference (TYPE) | POBJ_CONSUMER | Consumer making use of POBJ framework | 20060406 | ||
| 2 | POBJ_GUID |
Instance attribute | Public | Type reference (TYPE) | POBJ_LEVEL_GUID | GUID of the process object | 20060406 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CREATE |
Static method | Public | Method | Creates a Process Object and instantiates a level1 object | 20060406 |
| 2 | DELETE |
Instance method | Public | Method | Delete Levels or Attachments or Containers against any level | 20060406 |
| 3 | FLUSH |
Instance method | Public | Method | Persists the objects to the back end | 20060406 |
| 4 | GET |
Static method | Public | Method | Get the instance of POBJ class | 20060406 |
| 5 | GET_TOP_LEVEL |
Static method | Public | Method | Get the Top most parent Level (=1) Guid | 20060406 |
| 6 | IS_PERSISTENT |
Instance method | Public | Method | Is the POBJ Persisted? | 20060809 |
| 7 | LOCK |
Instance method | Public | Method | Locks the level objects associated with the POBJ | 20060406 |
| 8 | PACK |
Instance method | Public | Method | Serialize the base class level instance to a XML format | 20060406 |
| 9 | PURGE_POBJ_BUFFER |
Instance method | Public | Method | Clears all the attribute values in the buffer | 20070531 |
| 10 | QUERY |
Static method | Public | Method | Returns the Level 1 Details satisfying the Query Criteria | 20060406 |
| 11 | QUERY_USING_SEL_OPTIONS |
Static method | Public | Method | Query Using Select Options as Criteria | 20060925 |
| 12 | READ |
Instance method | Public | Method | Reads the Process Object | 20060406 |
| 13 | UNDO_BUFFER_CHANGES |
Instance method | Public | Method | Rollsback the POBJ Buffer Image to that of the DB Image | 20060406 |
| 14 | UNLOCK |
Instance method | Public | Method | Unlocks the Locked level objects associated with the POBJ | 20060406 |
| 15 | UNPACK |
Static method | Public | Method | DeSerialize the XML format to base class level instance | 20060406 |
| 16 | UPDATE |
Instance method | Public | Method | Updates the Process Object | 20060406 |
Events
Class IF_POBJ_PROCESS_OBJECT has no event.
Types
Class IF_POBJ_PROCESS_OBJECT has no local type.
Method Signatures
Method CREATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
CONSUMER_ID | Call by reference | Type reference (TYPE) | POBJ_CONSUMER | POBJ Consumer ID | 20060406 | ||
| 2 |  Changing |
POBJ_GUID | Call by reference | Type reference (TYPE) | POBJ_LEVEL_GUID | Key element of POBJ Level | 20060406 | ||
| 3 |  Exporting |
POBJ_INSTANCE | Call by reference | Object reference (TYPE REF TO) | IF_POBJ_PROCESS_OBJECT | Process Object Interface | 20060406 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_POBJ_PROCESS_OBJECT |
20060406 |
Method DELETE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
ATTACHMENT_DELETE_PARAMS | Call by reference | Type reference (TYPE) | POBJT_ATTACHMENT_DELETE_PARAMS | Delete Attachments | 20060425 | ||
| 2 | Importing |
CONTAINER_DELETE_PARAMS | Call by reference | Type reference (TYPE) | POBJT_CONTAINER_DELETE_PARAMS | Delete Containers | 20060425 | ||
| 3 | Importing |
LEVEL_DELETE_PARAMS | Call by reference | Type reference (TYPE) | POBJT_LEVEL_DELETE_PARAMS | Delete Levels | 20060425 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_POBJ_PROCESS_OBJECT |
20060406 |
Method FLUSH Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
NEW_TASK | Call by reference | Type reference (TYPE) | BOOLE_D | Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') | 20060406 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_POBJ_PROCESS_OBJECT |
20060406 |
Method GET Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
CONSUMER_ID | Call by reference | Type reference (TYPE) | POBJ_CONSUMER | POBJ Consumer ID | 20060621 | ||
| 2 | Importing |
POBJ_GUID | Call by reference | Type reference (TYPE) | POBJ_LEVEL_GUID | Key element of POBJ Level | 20060406 | ||
| 3 | Exporting |
POBJ_INSTANCE | Call by reference | Object reference (TYPE REF TO) | IF_POBJ_PROCESS_OBJECT | Process Object Interface | 20060406 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_POBJ_PROCESS_OBJECT |
20060406 |
Method GET_TOP_LEVEL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
CONSUMER_ID | Call by reference | Type reference (TYPE) | POBJ_CONSUMER | POBJ Consumer ID | 20060824 | ||
| 2 | Importing |
LEVEL | Call by reference | Type reference (TYPE) | POBJ_LEVEL | POBJ Level Values | 20060406 | ||
| 3 | Exporting |
LEVEL1_GUID | Call by reference | Type reference (TYPE) | POBJ_LEVEL_GUID | Key element of POBJ Level | 20060406 | ||
| 4 | Importing |
LEVEL_GUID | Call by reference | Type reference (TYPE) | POBJ_LEVEL_GUID | Key element of POBJ Level | 20060406 | ||
| 5 | Exporting |
LEVEL_OUT | Call by reference | Type reference (TYPE) | POBJ_LEVEL | POBJ Level Values | 20060809 | ||
| 6 | Exporting |
PARENT_GUID | Call by reference | Type reference (TYPE) | POBJ_LEVEL_GUID | Key element of POBJ Level | 20060807 | ||
| 7 | Exporting |
PARENT_LEVEL | Call by reference | Type reference (TYPE) | POBJ_LEVEL | POBJ Level Values | 20060809 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_POBJ_PROCESS_OBJECT |
20060406 |
Method IS_PERSISTENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Returning |
RETURN | Value transfer | Type reference (TYPE) | BOOLE_D | Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') | 20060809 |
Method IS_PERSISTENT on class IF_POBJ_PROCESS_OBJECT has no exception.
Method LOCK Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ALREADY_LOCKED | Call by reference | Type reference (TYPE) | BOOLE_D | Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') | 20060524 | ||
| 2 | Importing |
LOCK_OBJECT | Call by reference | Type reference (TYPE) | POBJT_LOCK_OBJECTS | Lock Objects | 20060406 | ||
| 3 | Exporting |
LOCK_USER | Call by reference | Type reference (TYPE) | SY-UNAME | User Name | 20060524 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_POBJ_PROCESS_OBJECT |
20060406 |
Method PACK Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
XML_LEVEL1 | Call by reference | Type reference (TYPE) | POBJ_CONTENT_X | XSTRING | 20060516 | ||
| 2 | Exporting |
XML_LEVEL2_TAB | Call by reference | Type reference (TYPE) | POBJT_XSTRING | Table of XSTRING | 20060407 | ||
| 3 | Exporting |
XML_LEVEL3_TAB | Call by reference | Type reference (TYPE) | POBJT_XSTRING | Table of XSTRING | 20060407 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_POBJ_PROCESS_OBJECT |
20060406 |
Method PURGE_POBJ_BUFFER Signature
Method PURGE_POBJ_BUFFER on class IF_POBJ_PROCESS_OBJECT has no parameter.
Method PURGE_POBJ_BUFFER on class IF_POBJ_PROCESS_OBJECT has no exception.
Method QUERY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
ATTACHMENT_SEARCH_CRITERIA | Call by reference | Type reference (TYPE) | POBJS_ATTACHMENT_ATTRIBUTES | 20060406 | |||
| 2 | Importing |
CONSUMER_ID | Call by reference | Type reference (TYPE) | POBJ_CONSUMER | POBJ Consumer ID | 20060406 | ||
| 3 | Importing |
LEVEL_SEARCH_CRITERIAS | Call by reference | Type reference (TYPE) | POBJT_LEVEL_SEARCH_IN | Level Search - Importing | 20060406 | ||
| 4 | Exporting |
LEVEL_SEARCH_OUTPUTS | Call by reference | Type reference (TYPE) | POBJT_LEVEL_HIT_LIST | Level Search Output | 20060406 | ||
| 5 | Importing |
NO_OF_MAX_HITS | Call by reference | Type reference (TYPE) | INT4 | Natural Number | 20061123 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_POBJ_PROCESS_OBJECT |
20060406 |
Method QUERY_USING_SEL_OPTIONS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
ATTACHMENT_SEARCH_CRITERIA | Call by reference | Type reference (TYPE) | POBJT_ATTA_SRCH_SEL_OPTIONS_IN | Table of Level Search Criteria using Select Options | 20060925 | ||
| 2 | Importing |
CONSUMER_ID | Call by reference | Type reference (TYPE) | POBJ_CONSUMER | POBJ Consumer ID | 20060925 | ||
| 3 | Importing |
LEVEL_SEARCH_CRITERIA | Call by reference | Type reference (TYPE) | POBJT_LVL_SRCH_SEL_OPTIONS_IN | Table of Level Search Criteria using Select Options | 20060925 | ||
| 4 | Exporting |
LEVEL_SEARCH_OUTPUT | Call by reference | Type reference (TYPE) | POBJT_LEVEL_HIT_LIST | Level Search Output | 20060925 | ||
| 5 | Importing |
NO_OF_MAX_HITS | Call by reference | Type reference (TYPE) | INT4 | Natural Number | 20061123 |
Method QUERY_USING_SEL_OPTIONS on class IF_POBJ_PROCESS_OBJECT has no exception.
Method READ Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ATTACHMENTS | Call by reference | Type reference (TYPE) | POBJT_ATTACHMENTS | Table of Attachments with Level Information | 20060406 | ||
| 2 | Importing |
ATTACHMENT_PARAMS | Call by reference | Type reference (TYPE) | POBJT_ATTACHMENT_PARAMS | Attachments Parameters | 20060421 | ||
| 3 | Exporting |
ATTRIBUTE_LOG | Call by reference | Type reference (TYPE) | POBJT_ATTRIBUTE_LOG | Change Attribute Log | 20060926 | ||
| 4 | Importing |
ATTRIBUTE_LOG_PARAMS | Call by reference | Type reference (TYPE) | POBJT_LEVEL_KEY | Table of Level and Level Guid | 20060926 | ||
| 5 | Exporting |
BOR_OBJECTS | Call by reference | Type reference (TYPE) | POBJT_BOR_OBJECTS | Table of Bor Objects with Level Information | 20060406 | ||
| 6 | Importing |
BOR_OBJECT_PARAMS | Call by reference | Type reference (TYPE) | POBJT_BOR_OBJECT_PARAMS | BOR Objects Parameters | 20060421 | ||
| 7 | Exporting |
CONTAINERS | Call by reference | Type reference (TYPE) | POBJT_CONTAINERS | Table of Containers with Level Information | 20060406 | ||
| 8 | Importing |
CONTAINER_PARAMS | Call by reference | Type reference (TYPE) | POBJT_CONTAINER_PARAMS | Container Parameter | 20060421 | ||
| 9 | Exporting |
LEVEL_ATTRIBUTES | Call by reference | Type reference (TYPE) | POBJT_LEVELKEY_WITH_ATTRIBUTES | Table of Level Attributes with Level Key | 20060406 | ||
| 10 | Importing |
LEVEL_ATTRIBUTE_PARAMS | Call by reference | Type reference (TYPE) | POBJT_LEVEL_KEY | Level Attributes Parameters | 20060421 | ||
| 11 | Exporting |
LINKED_LEVELS | Call by reference | Type reference (TYPE) | POBJT_LINKED_LEVEL_DETAILS | Table of Linked Level Details | 20060406 | ||
| 12 | Importing |
LINKED_LEVEL_PARAMS | Call by reference | Type reference (TYPE) | POBJT_LINKED_LEVEL_PARAMS | 20060421 | |||
| 13 | Exporting |
NOTES | Call by reference | Type reference (TYPE) | POBJT_NOTES | Table of Notes with Level information | 20060406 | ||
| 14 | Importing |
NOTE_PARAMS | Call by reference | Type reference (TYPE) | POBJT_LEVEL_KEY | Note Parameters | 20060421 | ||
| 15 | Exporting |
OBJECTS | Call by reference | Type reference (TYPE) | POBJT_OBJECTS | Table of Objects | 20060406 | ||
| 16 | Importing |
READ_FROM_DB | Call by reference | Type reference (TYPE) | BOOLE_D | Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') | 20070531 | ||
| 17 | Importing |
REQUEST_READ_OBJECTS | Call by reference | Type reference (TYPE) | BOOLE_D | Objects Parameters | 20060424 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_POBJ_PROCESS_OBJECT |
20060406 |
Method UNDO_BUFFER_CHANGES Signature
Method UNDO_BUFFER_CHANGES on class IF_POBJ_PROCESS_OBJECT has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_POBJ_PROCESS_OBJECT |
20060406 |
Method UNLOCK Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
UNLOCK_OBJECT | Call by reference | Type reference (TYPE) | POBJT_UNLOCK_OBJECTS | Unlock Objects | 20060406 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_POBJ_PROCESS_OBJECT |
20060406 |
Method UNPACK Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
POBJ_GUID | Call by reference | Type reference (TYPE) | POBJ_LEVEL_GUID | Key element of POBJ Level | 20060516 | ||
| 2 | Exporting |
POBJ_INSTANCE | Call by reference | Object reference (TYPE REF TO) | IF_POBJ_PROCESS_OBJECT | POBJ Base Level 1 Interface | 20060516 | ||
| 3 | Importing |
XML_LEVEL1 | Call by reference | Type reference (TYPE) | POBJ_CONTENT_X | 20060425 | |||
| 4 | Importing |
XML_LEVEL2_TAB | Call by reference | Type reference (TYPE) | POBJT_XSTRING | Table of XSTRINGS | 20060407 | ||
| 5 | Importing |
XML_LEVEL3_TAB | Call by reference | Type reference (TYPE) | POBJT_XSTRING | Table of XSTRINGS | 20060407 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_POBJ_PROCESS_OBJECT |
20060406 |
Method UPDATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Changing |
ATTACHMENTS | Call by reference | Type reference (TYPE) | POBJT_ATTACHMENTS | Table of Attachments with Level Information | 20060406 | ||
| 2 | Changing |
BOR_OBJECTS | Call by reference | Type reference (TYPE) | POBJT_BOR_OBJECTS | Table of Bor Objects with Level Information | 20060407 | ||
| 3 | Changing |
CONTAINERS | Call by reference | Type reference (TYPE) | POBJT_CONTAINERS | Table of Containers with Level Information | 20060406 | ||
| 4 | Changing |
LEVEL_ATTRIBUTE | Call by reference | Type reference (TYPE) | POBJT_LEVELKEY_WITH_ATTRIBUTES | Table of Level Attributes with Level Key | 20060406 | ||
| 5 | Changing |
LINKED_LEVELS | Call by reference | Type reference (TYPE) | POBJT_LINKED_LEVEL_DETAILS | Table of Linked Levels | 20060406 | ||
| 6 | Changing |
NOTES | Call by reference | Type reference (TYPE) | POBJT_NOTES | Table of Notes with Level information | 20060406 | ||
| 7 | Changing |
OBJECTS | Call by reference | Type reference (TYPE) | POBJT_OBJECTS | Table of Objects | 20060406 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_POBJ_PROCESS_OBJECT |
20060406 |
History
| Last changed by/on | SAP | 20071120 |
| SAP Release Created in |
