SAP ABAP Class CL_DOC_OBJ_REF_EXTRACT (Class for BAdI Impl.: Docum - Obj Reference)
Hierarchy
☛
BBPCRM (Software Component) BBPCRM
⤷
CA-DMS (Application Component) Document Management System
⤷
CV (Package) Application Development: R/3 Document Management
⤷
⤷
Meta Relationship - Using
| # | Relationship type | Using | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | IF_BADI_ESH_IF_OBJECT_DATA | Object data by list of object ids | 20080410 |
| 2 | Interface implementation (CLASS c. INTERFACES i_ref) | IF_BADI_INTERFACE | Tag Interface for BAdIs | 20080410 |
Properties
| Class | CL_DOC_OBJ_REF_EXTRACT | |
| Short Description | Class for BAdI Impl.: Docum - Obj Reference | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | CV | Application Development: R/3 Document Management |
| Created | 20080410 | SAP |
| Last change | 20100310 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) | |
| 2 | Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) | |
| 3 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
| # | Interface | Abstract | Final | Description | Created on |
|---|---|---|---|---|---|
| 1 | IF_BADI_ESH_IF_OBJECT_DATA | Object data by list of object ids | 20080410 | ||
| 2 | IF_BADI_INTERFACE | Tag Interface for BAdIs | 20080410 |
Friends
Class CL_DOC_OBJ_REF_EXTRACT has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Constant | Private | Type reference (TYPE) | ESH_E_OM_NODE_NAME | CVESO_ESN_DOC_OREF_ROOT | Node Name | 20080410 | ||
| 2 | Constant | Public | Type reference (TYPE) | ESH_E_OM_OBJECT_TYPE | CVESO_ESO_DOCUM_OBJ_REF | Object Type | 20080410 | ||
| 3 | Constant | Private | Type reference (TYPE) | TABNAM | CVESO_DRAD | Table Name | 20080414 | ||
| 4 | Static Attribute | Private | Object reference (TYPE REF TO) | CL_ESH_IF_GENERIC_DB_ITERATOR | Extract data from any DB table | 20080410 | |||
| 5 | Static Attribute | Protected | Type reference (TYPE) | CL_ESO_EXTRACTION_TOOLS=>GTY_TS_FIELDNAME | 20080410 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Static method | Public | Constructor | CLASS_CONSTRUCTOR | 20080410 | |
| 2 | Instance method | Private | Method | Get object data by list of object ids | 20080410 | |
| 3 | Instance method | Private | Method | get a set of data for given root node | 20080410 | |
| 4 | Instance method | Private | Method | Get next data package by last object id | 20080410 |
Events
Class CL_DOC_OBJ_REF_EXTRACT has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | GTY_S_CHANGEPOINTER | Public | See coding | 20080804 | begin of GTY_S_CHANGEPOINTER.
types DOKAR type DOKAR.
types DOKNR type DOKNR.
types DOKVR type DOKVR.
types DOKTL type DOKTL_D.
types DOKOB type DOKOB.
types OBZAE type OBZAE.
types OBJKY type OBJKY.
types end of gty_s_changepointer
|
Method Signatures
Method CLASS_CONSTRUCTOR Signature
Method CLASS_CONSTRUCTOR on class CL_DOC_OBJ_REF_EXTRACT has no parameter.
Method CLASS_CONSTRUCTOR on class CL_DOC_OBJ_REF_EXTRACT has no exception.
Method GET_DATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_MESSAGES | Call by reference | Type reference (TYPE) | BAPIRETTAB | Table with BAPI Return Information | 20080410 | |||
| 2 | IT_OBJECT_EXTRACTION | Call by reference | Type reference (TYPE) | ESH_T_IF_EXTRACT_NODES | Extraction of nodes | 20080410 | |||
| 3 | IT_OBJECT_IDS | Call by reference | Type reference (TYPE) | ESH_T_IF_CHANGED_OBJECTS | Changed Objects | 20080410 | |||
| 4 | IV_OBJECT_TYPE_BACKEND_NAME | Call by reference | Type reference (TYPE) | ESH_E_OM_BACKEND_NAME | Backend Name | 20080410 | |||
| 5 | IV_OBJECT_TYPE_ID | Call by reference | Type reference (TYPE) | ESH_E_OM_OBJECT_TYPE | Object Type | 20080410 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | General error in provider | 20080410 |
Method GET_ROOT_NODE_DATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_MESSAGES | Call by reference | Type reference (TYPE) | BAPIRETTAB | Table with BAPI Return Information | 20080410 | |||
| 2 | EV_LAST_OBJECT_ID | Call by reference | Type reference (TYPE) | ESH_E_IF_GENERAL_ID | General ID | 20080410 | |||
| 3 | EV_NO_MORE_DATA | Call by reference | Type reference (TYPE) | XFELD | Checkbox | 20080410 | |||
| 4 | IS_OBJECT_EXTRACTION | Call by reference | Type reference (TYPE) | ESH_S_IF_EXTRACT_NODE | Extraction of one node | 20080410 | |||
| 5 | IV_LAST_OBJECT_ID | Call by reference | Type reference (TYPE) | ESH_E_IF_GENERAL_ID | General ID | 20080410 | |||
| 6 | IV_PACKAGE_SIZE | Call by reference | Type reference (TYPE) | ESH_E_IF_PACKAGE_SIZE | Package size | 20080410 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | General error in provider | 20080410 |
Method NEXT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_MESSAGES | Call by reference | Type reference (TYPE) | BAPIRETTAB | Table with BAPI Return Information | 20080410 | |||
| 2 | EV_LAST_OBJECT_ID | Call by reference | Type reference (TYPE) | ESH_E_IF_GENERAL_ID | General ID | 20080410 | |||
| 3 | EV_NO_MORE_DATA | Call by reference | Type reference (TYPE) | XFELD | Checkbox | 20080410 | |||
| 4 | IT_OBJECT_EXTRACTION | Call by reference | Type reference (TYPE) | ESH_T_IF_EXTRACT_NODES | Extraction of nodes | 20080410 | |||
| 5 | IV_LAST_OBJECT_ID | Call by reference | Type reference (TYPE) | ESH_E_IF_GENERAL_ID | General ID | 20080410 | |||
| 6 | IV_OBJECT_TYPE_BACKEND_NAME | Call by reference | Type reference (TYPE) | ESH_E_OM_BACKEND_NAME | Backend Name | 20080410 | |||
| 7 | IV_OBJECT_TYPE_ID | Call by reference | Type reference (TYPE) | ESH_E_OM_OBJECT_TYPE | Object Type | 20080410 | |||
| 8 | IV_PACKAGE_SIZE | Call by reference | Type reference (TYPE) | ESH_E_IF_PACKAGE_SIZE | Package size | 20080410 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | General error in provider | 20080410 |
History
| Last changed by/on | SAP | 20100310 |
| SAP Release Created in | 604 |