SAP ABAP Class CL_RSOS_ES_OBJ (Base class for templates)
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
⤷
⤷
Meta Relationship - Using
| # | Relationship type | Using | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | IF_RSOS_ES_OBJ_INDEXING | Indexing interface for object types | 20100727 |
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Inheritance (c INHERITING FROM c_ref) | CL_RSOS_ES_OBJ_GENERIC | Generic class for all types in ES repository | 20100625 |
| 2 | Inheritance (c INHERITING FROM c_ref) | CL_RSOS_ES_OBJ_TLOGO | Generic class for all TLOGO types | 20100624 |
Properties
| Class | CL_RSOS_ES_OBJ | |
| Short Description | Base class for templates | |
| 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 | 20100624 | SAP |
| Last change | 20110908 | 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 | Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) | |
| 4 | Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) | |
| 5 | Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
Interfaces
| # | Interface | Abstract | Final | Description | Created on |
|---|---|---|---|---|---|
| 1 | IF_RSOS_ES_OBJ_INDEXING | Indexing interface for object types | 20100727 |
Friends
Class CL_RSOS_ES_OBJ has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Constant | Public | See coding | 20100624 | |||||
| 2 | Constant | Public | See coding | 20100624 | |||||
| 3 | Constant | Public | See coding | 20100624 | |||||
| 4 | Constant | Public | See coding | 20100624 | |||||
| 5 | Instance attribute | Public | Type reference (TYPE) | ESH_E_OM_WEB_ICON | Icon | 20100624 | |||
| 6 | Instance attribute | Public | Attribute reference (LIKE) | C_NAV_UITYPE | Navigation UI type | 20100624 | |||
| 7 | Instance attribute | Public | Type reference (TYPE) | ESH_E_OM_OBJECT_TYPE | Object type | 20100624 | |||
| 8 | Instance attribute | Public | Type reference (TYPE) | CL_RSOS_ES_ASSOCIATION=>TTR_ASSOCIATION | Associations | 20100624 | |||
| 9 | Instance attribute | Public | Type reference (TYPE) | CL_RSOS_ES_ATTRIBUTE=>TTR_ATTRIBUTE | Object attributes | 20100624 | |||
| 10 | Instance attribute | Public | Type reference (TYPE) | IF_RSOS_ES_AUTHORIZATION=>TTR_AUTHORIZATION | Authorization | 20100624 | |||
| 11 | Instance attribute | Public | Type reference (TYPE) | TT_CATEGORY | Category of the Object type | 20100625 | |||
| 12 | Instance attribute | Public | Type reference (TYPE) | TT_KEYWORD | Key words | 20100624 | |||
| 13 | Instance attribute | Public | Type reference (TYPE) | TT_NAVFLD_MAPPING | Navigation field mapping | 20100624 | |||
| 14 | Instance attribute | Public | Type reference (TYPE) | TT_NAVOPRN_TEXT | Text for navigation operations | 20100624 | |||
| 15 | Instance attribute | Public | Type reference (TYPE) | TT_NAV_TARGET | Navigation targets | 20100624 | |||
| 16 | Instance attribute | Public | Type reference (TYPE) | TT_OBJTYPE_TEXT | Object text | 20100701 | |||
| 17 | Instance attribute | Public | Type reference (TYPE) | TT_REQ_TEXT | Request Texts | 20100716 | |||
| 18 | Instance attribute | Protected | Type reference (TYPE) | CL_RSOS_ES_ASSOCIATION=>TTR_ASSOCIATION | Reverse associations on me | 20100706 | |||
| 19 | Static Attribute | Private | Type reference (TYPE) | TTH_OBJTYPE_REF | Cached object type instances | 20100624 | |||
| 20 | Static Attribute | Private | Type reference (TYPE) | TTH_OBJ_INDEXING | Cached obj-indexing references | 20100727 | |||
| 21 | Static Attribute | Private | Type reference (TYPE) | TT_REG_OBJTYPE | Registry names and corresponding object types | 20100624 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Static method | Public | Constructor | CLASS_CONSTRUCTOR | 20100624 | |
| 2 | Instance method | Protected | Method | Get instance of Object class | 20100624 | |
| 3 | Instance method | Public | Method | Get associations from Object Type to me | 20100706 | |
| 4 | Instance method | Public | Method | Get reference to Attribute object | 20100702 | |
| 5 | Instance method | Protected | Method | Get Object types for Registry name | 20100624 | |
| 6 | Static method | Public | Method | Get object instance for indexing | 20100727 | |
| 7 | Static method | Public | Method | Get object properties | 20100624 | |
| 8 | Static method | Public | Method | Get all object types | 20100624 | |
| 9 | Instance method | Protected | Method | Get object types having association to me | 20100706 | |
| 10 | Instance method | Public | Method | Get template name | 20100624 | |
| 11 | Instance method | Public | Method | Get template type | 20100624 | |
| 12 | Static method | Public | Method | Check if a object type is valid | 20100707 |
Events
Class CL_RSOS_ES_OBJ has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | TS_KEYWORD | Public | Type reference (TYPE) | CL_RSOS_ES_ATTRIBUTE=>TS_ATRTEXT | 20100624 | |
|
| 2 | TS_NAVFLD_MAPPING | Public | See coding | 20100624 | BEGIN OF ts_navfld_mapping,
operation_id TYPE c LENGTH 32,
field_id TYPE esh_e_om_node_field,
attribute TYPE esh_e_if_target_parameter,
END OF ts_navfld_mapping
|
||
| 3 | TS_NAVOPRN_TEXT | Public | See coding | 20100624 | BEGIN OF ts_navoprn_text,
operation_id TYPE c LENGTH 32,
langu TYPE laiso,
text TYPE esh_e_om_description,
END OF ts_navoprn_text
|
||
| 4 | TS_NAV_TARGET | Public | See coding | 20100624 | BEGIN OF ts_nav_target,
operation_id TYPE c LENGTH 32,
operation TYPE string,
order TYPE i,
selected TYPE abap_bool,
disp_mode TYPE c LENGTH 10,
END OF ts_nav_target
|
||
| 5 | TS_OBJTYPE_REF | Protected | See coding | 20100624 | BEGIN OF ts_objtype_ref,
objtype TYPE string,
ref TYPE REF TO cl_rsos_es_obj,
END OF ts_objtype_ref
|
||
| 6 | TS_OBJTYPE_TEXT | Public | Type reference (TYPE) | CL_RSOS_ES_ATTRIBUTE=>TS_ATRTEXT | 20100624 | |
|
| 7 | TS_OBJ_INDEXING | Private | See coding | 20100727 | BEGIN OF ts_obj_indexing,
objtype TYPE esh_e_om_object_type,
ref TYPE REF TO if_rsos_es_obj_indexing,
END OF ts_obj_indexing
|
||
| 8 | TS_REG_OBJTYPE | Private | See coding | 20100624 | BEGIN OF ts_reg_objtype,
regname TYPE rsos_es_regname,
class TYPE classname,
objtype TYPE esh_e_om_object_type,
END OF ts_reg_objtype
|
||
| 9 | TTH_OBJTYPE_REF | Protected | See coding | 20100624 | tth_objtype_ref TYPE HASHED TABLE OF ts_objtype_ref WITH UNIQUE KEY objtype
|
||
| 10 | TTH_OBJ_INDEXING | Private | See coding | 20100727 | tth_obj_indexing TYPE HASHED TABLE OF ts_obj_indexing WITH UNIQUE KEY objtype
|
||
| 11 | TT_CATEGORY | Public | See coding | 20100624 | tt_category TYPE STANDARD TABLE OF t_category
|
||
| 12 | TT_KEYWORD | Public | See coding | 20100624 | tt_keyword TYPE STANDARD TABLE OF ts_keyword
|
||
| 13 | TT_NAVFLD_MAPPING | Public | See coding | 20100624 | tt_navfld_mapping TYPE TABLE OF ts_navfld_mapping
|
||
| 14 | TT_NAVOPRN_TEXT | Public | See coding | 20100624 | tt_navoprn_text TYPE TABLE OF ts_navoprn_text
|
||
| 15 | TT_NAV_TARGET | Public | See coding | 20100624 | tt_nav_target TYPE TABLE OF ts_nav_target
|
||
| 16 | TT_OBJTYPE | Public | See coding | 20100624 | tt_objtype TYPE STANDARD TABLE OF esh_e_om_object_type
|
||
| 17 | TT_OBJTYPE_TEXT | Public | See coding | 20100624 | tt_objtype_text TYPE STANDARD TABLE OF ts_objtype_text
|
||
| 18 | TT_REG_OBJTYPE | Private | See coding | 20100624 | tt_reg_objtype TYPE STANDARD TABLE OF ts_reg_objtype
|
||
| 19 | TT_REQ_TEXT | Public | See coding | 20100716 | tt_req_text TYPE TABLE OF rsos_es_requestt
|
||
| 20 | T_CATEGORY | Public | Type reference (TYPE) | ESH_E_OM_CATEGORY | 20100624 | |
Method Signatures
Method CLASS_CONSTRUCTOR Signature
Method CLASS_CONSTRUCTOR on class CL_RSOS_ES_OBJ has no parameter.
Method CLASS_CONSTRUCTOR on class CL_RSOS_ES_OBJ has no exception.
Method GET Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_OBJTYPE | Call by reference | Type reference (TYPE) | ESH_E_OM_NODE_NAME | Object type | 20100624 |
Method GET on class CL_RSOS_ES_OBJ has no exception.
Method GET_ASSO_FROM_OBJTYPES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | E_TR_ASSOCIATION | Call by reference | Type reference (TYPE) | CL_RSOS_ES_ASSOCIATION=>TTR_ASSOCIATION | Table of associations | 20100706 |
Method GET_ASSO_FROM_OBJTYPES on class CL_RSOS_ES_OBJ has no exception.
Method GET_ATR_REF Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_ATRNAME | Call by reference | Type reference (TYPE) | ESH_E_OM_NODE_FIELD | Attribute name | 20100702 | |||
| 2 | R_R_ATTRIBUTE | Value transfer | Object reference (TYPE REF TO) | CL_RSOS_ES_ATTRIBUTE | Object attribute | 20100702 |
Method GET_ATR_REF on class CL_RSOS_ES_OBJ has no exception.
Method GET_OBJTYPES_FOR_REG Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | E_T_OBJTYPE | Value transfer | Type reference (TYPE) | TT_OBJTYPE | Search-enabled object types under registry name | 20100624 |
Method GET_OBJTYPES_FOR_REG on class CL_RSOS_ES_OBJ has no exception.
Method GET_OBJ_INDEXING Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_OBJTYPE | Call by reference | Type reference (TYPE) | ESH_E_OM_OBJECT_TYPE | Object Type | 20100727 | |||
| 2 | R_R_OBJ_INDEX | Value transfer | Object reference (TYPE REF TO) | IF_RSOS_ES_OBJ_INDEXING | Indexing interface for object types | 20100727 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Exception Class | 20100727 |
Method GET_OBJ_TYPE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_OBJTYPE | Call by reference | Type reference (TYPE) | ESH_E_OM_OBJECT_TYPE | Object type | 20100624 | |||
| 2 | R_R_OBJTYPE | Value transfer | Object reference (TYPE REF TO) | CL_RSOS_ES_OBJ | Instance of the object type class | 20100624 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Exception Class | 20100707 |
Method GET_OBJ_TYPES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | E_T_OBJTYPE | Value transfer | Type reference (TYPE) | TT_OBJTYPE | Object types | 20100624 |
Method GET_OBJ_TYPES on class CL_RSOS_ES_OBJ has no exception.
Method GET_RELATED_OBJTYPES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | E_T_OBJTYPE | Value transfer | Type reference (TYPE) | CL_RSOS_ES_OBJ=>TT_OBJTYPE | Releated object types | 20100706 |
Method GET_RELATED_OBJTYPES on class CL_RSOS_ES_OBJ has no exception.
Method GET_TEMPLATE_NAME Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | R_TEMPLATE_NAME | Value transfer | Type reference (TYPE) | ESH_E_IF_BACKEND_TEMPLATE | Template name | 20100624 |
Method GET_TEMPLATE_NAME on class CL_RSOS_ES_OBJ has no exception.
Method GET_TEMPLATE_TYPE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | R_TEMPLATE_TYPE | Value transfer | Attribute reference (LIKE) | C_TEMPLATE_TYPE | Template type | 20100624 |
Method GET_TEMPLATE_TYPE on class CL_RSOS_ES_OBJ has no exception.
Method IS_OBJTYPE_VALID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_OBJTYPE | Call by reference | Type reference (TYPE) | ESH_E_OM_OBJECT_TYPE | Object Type | 20100707 | |||
| 2 | R_VALID | Value transfer | Type reference (TYPE) | ABAP_BOOL | Boolean | 20100707 |
Method IS_OBJTYPE_VALID on class CL_RSOS_ES_OBJ has no exception.
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in | 730 |