SAP ABAP Class CL_RSOS_ES_INDEXING (Class for Indexing.)
Hierarchy
☛
SAP_BW (Software Component) SAP Business Warehouse
⤷
BW-WHM-MTD (Application Component) Metadata (Repository)
⤷
RSOS_ES (Package) BI Implementation of the Enterprise Search Connector
SAP_BW (Software Component) SAP Business Warehouse⤷
BW-WHM-MTD (Application Component) Metadata (Repository)⤷
RSOS_ES (Package) BI Implementation of the Enterprise Search ConnectorMeta Relationship - Using
| # | Relationship type | Using | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | IF_ESH_IF_OBJECT_DATA_BY_ID | Object data by list of object ids | 20090723 |
| 2 | Interface implementation (CLASS c. INTERFACES i_ref) | IF_ESH_IF_OBJECT_ITERATOR | Object data iterator by last object id | 20090702 |
Properties
| Class | CL_RSOS_ES_INDEXING | |
| Short Description | Class for Indexing. | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | RSOS_ES | BI Implementation of the Enterprise Search Connector |
| Created | 20090702 | SAP |
| Last change | 20130531 | 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 | IF_RSOS_ES_OBJ_INDEXING |
Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
| 3 | RS |
Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
| # | Interface | Abstract | Final | Description | Created on |
|---|---|---|---|---|---|
| 1 | IF_ESH_IF_OBJECT_DATA_BY_ID | Object data by list of object ids | 20090723 | ||
| 2 | IF_ESH_IF_OBJECT_ITERATOR | Object data iterator by last object id | 20090702 |
Friends
Class CL_RSOS_ES_INDEXING has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | N_C_ALL_CLIENT_USERS |
Constant | Public | Type reference (TYPE) | CHAR32 | '!$ALL_CLIENT_USERS$!' | Special entry for all user changes in all clients | 20100216 | |
| 2 | N_C_SINGLE_CLIENT_USERS |
Constant | Public | Type reference (TYPE) | CHAR32 | '!$SINGLE_CLIENT_USERS$!' | Special entry for all user changes in a single client | 20100216 | |
| 3 | P_C_SW_COMP |
Constant | Private | Type reference (TYPE) | CHAR32 | 'SAP_BW' | ES software component for BW | 20100129 | |
| 4 | P_OBJECT_TYPE_ID |
Instance attribute | Private | Type reference (TYPE) | ESH_E_OM_OBJECT_TYPE | Object Type | 20090821 | ||
| 5 | P_TASKCOUNT |
Instance attribute | Private | Type reference (TYPE) | I | 0 | Count of parallel task | 20091223 | |
| 6 | P_T_LANGU |
Static Attribute | Private | Type reference (TYPE) | RSAOS_T_LANGU | Table of installed languages | 20100210 | ||
| 7 | P_T_OBJTEXT |
Instance attribute | Private | Type reference (TYPE) | RSOS_ES_T_OBJTXT | Table of object description | 20100215 | ||
| 8 | P_T_OBJ_BUFFER |
Static Attribute | Private | Type reference (TYPE) | IF_RSOS_ES_OBJ_INDEXING=>TT_OBJECT_LIST | TLOGO Object collection | 20100203 | ||
| 9 | P_T_ROLES_OBJECTS |
Static Attribute | Private | Type reference (TYPE) | RSOS_ES_ROLES_OBJECTS | Roles and Objects (AGR_HIER) | 20100128 | ||
| 10 | P_T_USER_OBJECTS |
Static Attribute | Private | Type reference (TYPE) | RSOS_ES_USER_OBJECTS | User Favorites (SMEN_BUFFC) | 20100128 | ||
| 11 | P_T_USER_ROLES |
Static Attribute | Private | Type reference (TYPE) | RSOS_ES_USER_ROLES | User Roles (AGR_USERS) | 20100128 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CONSTRUCTOR |
Instance method | Public | Constructor | CONSTRUCTOR | 20090703 |
| 2 | EXTRACT_NODE_DATA |
Instance method | Private | Method | Extract data for a given node | 20110225 |
| 3 | EXTRACT_OBJECT_DATA |
Instance method | Private | Method | Extract data for one object | 20100205 |
| 4 | GET_DESCRIPTION |
Instance method | Private | Method | Get description for a TLogo object in all languages | 20090819 |
| 5 | GET_NEXT_PACKAGE |
Instance method | Private | Method | Get next package of objects to index | 20100203 |
| 6 | SET_CHANGEPTR |
Static method | Public | Method | Set ES Change Pointer on change of BW object | 20100129 |
| 7 | UPDATE_USERS |
Static method | Public | Method | Update given users in the current client | 20100122 |
Events
Class CL_RSOS_ES_INDEXING has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | ROLES_OBJECTS | Public | See coding | 20100128 | BEGIN OF roles_objects,
agr_name TYPE agr_name,
object_id TYPE hier_guid,
END OF roles_objects
|
||
| 2 | RSOS_ES_ROLES_OBJECTS | Public | See coding | 20100128 | rsos_es_roles_objects TYPE TABLE OF roles_objects
|
||
| 3 | RSOS_ES_USER | Public | See coding | 20100209 | BEGIN OF rsos_es_user,
bname TYPE xubname,
END OF rsos_es_user
|
||
| 4 | RSOS_ES_USERS | Public | See coding | 20100122 | rsos_es_users TYPE TABLE OF rsos_es_user
|
||
| 5 | RSOS_ES_USER_OBJECTS | Public | See coding | 20100128 | rsos_es_user_objects TYPE TABLE OF user_objects
|
||
| 6 | RSOS_ES_USER_ROLES | Public | See coding | 20100128 | rsos_es_user_roles TYPE TABLE OF user_roles
|
||
| 7 | USER_OBJECTS | Public | See coding | 20100128 | BEGIN OF user_objects,
uname TYPE syuname,
object_id TYPE hier_guid,
END OF user_objects
|
||
| 8 | USER_ROLES | Public | See coding | 20100128 | BEGIN OF user_roles,
agr_name TYPE agr_name,
uname TYPE xubname,
END OF user_roles
|
Method Signatures
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
I_OBJECT_TYPE_ID | Call by reference | Type reference (TYPE) | ESH_E_OM_OBJECT_TYPE | Object Type | 20090821 |
Method CONSTRUCTOR on class CL_RSOS_ES_INDEXING has no exception.
Method EXTRACT_NODE_DATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Changing |
C_EXTRACT_DATA | Call by reference | Type reference (TYPE) | ABAP_BOOL | 'X' | Extract Object | 20110225 | |
| 2 | Importing |
I_OBJTYPE | Call by reference | Type reference (TYPE) | ESH_E_OM_OBJECT_TYPE | Object Type | 20110225 | ||
| 3 | Importing |
I_OBJVERS | Call by reference | Type reference (TYPE) | RSOBJVERS | Object version | 20110225 | ||
| 4 | Importing |
I_S_NODE | Call by reference | Type reference (TYPE) | ESH_S_IF_EXTRACT_NODE | Extraction of one Node | 20110225 | ||
| 5 | Importing |
I_T_OBJECT_DATA | Call by reference | Type reference (TYPE) | RSOS_TX_SEATR_ATR | Object Data | 20110225 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_ESH_IF_PROVIDER_ERROR |
General Error in Provider | 20110225 |
Method EXTRACT_OBJECT_DATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
I_FULL_INDEX | Call by reference | Type reference (TYPE) | ABAP_BOOL | 'X' | Index all objects | 20101210 | |
| 2 | Importing |
I_OBJNM | Call by reference | Type reference (TYPE) | ESH_E_IF_GENERAL_ID | Object Name in Object Directory | 20100205 | ||
| 3 | Importing |
I_OBJTYPE | Call by reference | Type reference (TYPE) | ESH_E_OM_OBJECT_TYPE | Object type | 20100728 | ||
| 4 | Importing |
I_OBJVERS | Call by reference | Type reference (TYPE) | RSOBJVERS | Object version | 20100205 | ||
| 5 | Importing |
I_R_OBJTYPE | Call by reference | Object reference (TYPE REF TO) | IF_RSOS_ES_OBJ_INDEXING | Indexing interface for object types | 20100727 | ||
| 6 | Importing |
I_T_OBJ_XTRACT | Call by reference | Type reference (TYPE) | ESH_T_IF_EXTRACT_NODES | Extraction of nodes | 20100205 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ESH_IF_PROVIDER_ERROR |
General error in provider | 20100205 |
Method GET_DESCRIPTION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
I_R_OBJTYPE | Call by reference | Object reference (TYPE REF TO) | IF_RSOS_ES_OBJ_INDEXING | Indexing interface for object types | 20100727 | ||
| 2 | Importing |
I_T_OBJNM | Call by reference | Type reference (TYPE) | IF_RSOS_ES_OBJ_INDEXING=>TT_OBJECT_LIST | List of objects with TLOGO and version | 20100210 | ||
| 3 | Importing |
I_T_OBJ_XTRACT | Call by reference | Type reference (TYPE) | ESH_T_IF_EXTRACT_NODES | Extraction of nodes | 20100215 |
Method GET_DESCRIPTION on class CL_RSOS_ES_INDEXING has no exception.
Method GET_NEXT_PACKAGE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Changing |
ET_MESSAGES | Call by reference | Type reference (TYPE) | BAPIRETTAB | Table with BAPI Return Information | 20100409 | ||
| 2 |  Exporting |
E_NOMORE_DATA | Call by reference | Type reference (TYPE) | ABAP_BOOL | Buffer has more object for this TLOGO | 20100204 | ||
| 3 | Exporting |
E_T_OBJECT | Call by reference | Type reference (TYPE) | IF_RSOS_ES_OBJ_INDEXING=>TT_OBJECT_LIST | tlogo objects collection | 20100203 | ||
| 4 | Importing |
I_LAST_OBJECT_ID | Call by reference | Type reference (TYPE) | ESH_E_IF_GENERAL_ID | General ID | 20100203 | ||
| 5 | Importing |
I_OBJTYPE | Call by reference | Type reference (TYPE) | ESH_E_OM_OBJECT_TYPE | Object Type | 20100728 | ||
| 6 | Importing |
I_PACKAGE_SIZE | Call by reference | Type reference (TYPE) | I | Size of package | 20100203 | ||
| 7 | Importing |
I_R_OBJTYPE | Call by reference | Object reference (TYPE REF TO) | IF_RSOS_ES_OBJ_INDEXING | Indexing interface for object types | 20100727 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ESH_IF_PROVIDER_ERROR |
General error in provider | 20100203 |
Method SET_CHANGEPTR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
I_CHANGETP | Call by reference | Type reference (TYPE) | RSOS_CHANGETP | Type of Change (Metadata Queue) | 20100129 | ||
| 2 | Importing |
I_OBJNM | Call by reference | Type reference (TYPE) | SOBJ_NAME | Object Name in Object Directory | 20100129 | ||
| 3 | Importing |
I_TLOGO | Call by reference | Type reference (TYPE) | RS_TLOGO | TLOGO type | 20100129 |
Method SET_CHANGEPTR on class CL_RSOS_ES_INDEXING has no exception.
Method UPDATE_USERS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
I_T_USERS | Call by reference | Type reference (TYPE) | RSOS_ES_USERS | List of changed Users | 20100122 | ||
| 2 | Importing |
L_ALL_CLIENTS | Call by reference | Type reference (TYPE) | RS_BOOL | Boolean | 20100202 | ||
| 3 | Importing |
L_SINGLE_CLIENT | Call by reference | Type reference (TYPE) | RS_BOOL | Boolean | 20100128 |
Method UPDATE_USERS on class CL_RSOS_ES_INDEXING has no exception.
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in | 730 |
