SAP ABAP Class /AIN/CL_SEARCH_UI_HELPER (Search UI Helper Class)
Hierarchy
☛
AIN (Software Component) AIN 710: Add-On Installation
⤷
AIE-AII-UI (Application Component) User Interface
⤷
/AIN/UI (Package) Auto-ID User Interface
AIN (Software Component) AIN 710: Add-On Installation⤷
AIE-AII-UI (Application Component) User Interface⤷
/AIN/UI (Package) Auto-ID User InterfaceProperties
| Class | /AIN/CL_SEARCH_UI_HELPER | |
| Short Description | Search UI Helper Class | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | /AIN/UI | Auto-ID User Interface |
| Created | 20061130 | SAP |
| Last change | 20141109 | |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
Class /AIN/CL_SEARCH_UI_HELPER has no forward declaration.
Interfaces
Class /AIN/CL_SEARCH_UI_HELPER has no interface implemented.
Friends
Class /AIN/CL_SEARCH_UI_HELPER has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | C_ACTIVE |
Constant | Public | Type reference (TYPE) | DDGOTSTATE | 'A' | Status of an ABAP/4 Dictionary object | 20061201 | |
| 2 | C_ACT_OBJ_RTN_STRUCTURE |
Constant | Public | Type reference (TYPE) | DDOBJNAME | '/AIN/UI_DYN_ACT_OBJ_STR' | Name of ABAP Dictionary Object | 20061207 | |
| 3 | C_ACT_OBJ_RTN_TAB |
Constant | Public | Type reference (TYPE) | DDOBJNAME | '/AIN/UI_DYN_ACT_OBJ_TAB' | Name of ABAP Dictionary Object | 20061207 | |
| 4 | C_ACT_OBJ_STRUCTURE |
Constant | Public | Type reference (TYPE) | DDOBJNAME | '/AIN/UI_ACT_OBJECT_STR' | Name of ABAP Dictionary Object | 20061206 | |
| 5 | C_DOCUMENT_STRUCTURE |
Constant | Public | Type reference (TYPE) | DDOBJNAME | '/AIN/UI_DOCUMENT_STR' | Name of ABAP Dictionary Object | 20061130 | |
| 6 | C_DOC_CTX_PROFILE |
Constant | Public | Type reference (TYPE) | /AIN/PRF_PROFILE | 'SAP_DOCUMENT_CONTEXT_PROFILE' | Profile | 20061201 | |
| 7 | C_DOC_CTX_USAGE |
Constant | Public | Type reference (TYPE) | /AIN/PRF_ELEMENTSET_USAGE | '04' | Usage of Element Set in Profile | 20061201 | |
| 8 | C_DOC_ITM_RTN_STRUCTURE |
Constant | Public | Type reference (TYPE) | DDOBJNAME | '/AIN/DYN_ITM_STR' | Name of ABAP Dictionary Object | 20070120 | |
| 9 | C_DOC_ITM_RTN_TAB |
Constant | Public | Type reference (TYPE) | DDOBJNAME | '/AIN/DYN_ITM_TAB' | Name of ABAP Dictionary Object | 20070120 | |
| 10 | C_DOC_ITM_STRUCTURE |
Constant | Public | Type reference (TYPE) | DDOBJNAME | '/AIN/UI_DOC_ITEM_STR2' | Name of ABAP Dictionary Object | 20070120 | |
| 11 | C_DOC_RTN_STRUCTURE |
Constant | Public | Type reference (TYPE) | DDOBJNAME | '/AIN/UI_DYN_DOC_STR' | Name of ABAP Dictionary Object | 20061201 | |
| 12 | C_DOC_RTN_TAB |
Constant | Public | Type reference (TYPE) | DDOBJNAME | '/AIN/UI_DYN_DOC_TAB' | Name of ABAP Dictionary Object | 20061204 | |
| 13 | C_OBJECT_STRUCTURE |
Constant | Public | Type reference (TYPE) | DDOBJNAME | '/AIN/UI_OBJECT_STR' | Name of ABAP Dictionary Object | 20061130 | |
| 14 | C_OBJ_CTX_PROFILE |
Constant | Public | Type reference (TYPE) | /AIN/PRF_PROFILE | 'SAP_OBJ_CONTEXT_DISPLAY_PROFILE' | Profile | 20070403 | |
| 15 | C_OBJ_RTN_STRUCTURE |
Constant | Public | Type reference (TYPE) | DDOBJNAME | '/AIN/UI_DYN_OBJ_STR' | Name of ABAP Dictionary Object | 20061201 | |
| 16 | C_OBJ_RTN_TAB |
Constant | Public | Type reference (TYPE) | DDOBJNAME | '/AIN/UI_DYN_OBJ_TAB' | Name of ABAP Dictionary Object | 20061204 | |
| 17 | C_OBS_CTX_PROFILE |
Constant | Public | Type reference (TYPE) | /AIN/PRF_PROFILE | 'SAP_OBS_CONTEXT_DISPLAY_PROFILE' | Profile | 20070403 | |
| 18 | C_PACK_RTN_STRUCTURE |
Constant | Public | Type reference (TYPE) | DDOBJNAME | '/AIN/DYN_PACK_STR' | Name of ABAP Dictionary Object | 20070118 | |
| 19 | C_PACK_RTN_TAB |
Constant | Public | Type reference (TYPE) | DDOBJNAME | '/AIN/DYN_PACK_TAB' | Name of ABAP Dictionary Object | 20070118 | |
| 20 | C_PACK_STRUCTURE |
Constant | Public | Type reference (TYPE) | DDOBJNAME | '/AIN/UI_PACK_LINE_ITEM_STR' | Name of ABAP Dictionary Object | 20070118 | |
| 21 | C_STRUCTURE_TEXT |
Constant | Public | Type reference (TYPE) | AS4TEXT | 'UI Return Dynamic Structure' | Short Description of Repository Objects | 20061130 | |
| 22 | C_USER_DATA_USAGE |
Constant | Public | Type reference (TYPE) | /AIN/PRF_ELEMENTSET_USAGE | '21' | Usage of Element Set in Profile | 20070403 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CONSTRUCT_AIN_URL |
Static method | Public | Method | Build the URL by adding AIN parameters | 20140327 |
| 2 | CONVERT_LOCAL_TIMESTAMP |
Static method | Public | Method | 20061205 | |
| 3 | CREATE_PACK_STRUCTURE |
Static method | Public | Method | 20070118 | |
| 4 | CREATE_RETURN_STRUCTURE |
Static method | Public | Method | Helper method to create dynamic return structures | 20061130 |
| 5 | DELETE_RETURN_STRUCTURE |
Static method | Public | Method | 20061201 | |
| 6 | GET_CTX_ELEMENTS |
Static method | Public | Method | 20070403 | |
| 7 | GET_SAP_ALL_FIELDS |
Static method | Public | Method | 20061208 | |
| 8 | IS_CONTEXT_CHANGED |
Static method | Public | Method | helper method to determine if context has changed | 20061201 |
Events
Class /AIN/CL_SEARCH_UI_HELPER has no event.
Types
Class /AIN/CL_SEARCH_UI_HELPER has no local type.
Method Signatures
Method CONSTRUCT_AIN_URL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Returning |
EV_URL | Value transfer | Type reference (TYPE) | STRING | 20140327 | |||
| 2 |  Importing |
IV_PARAMETER_ID | Call by reference | Type reference (TYPE) | STRING | 20140327 | |||
| 3 | Importing |
IV_URL | Call by reference | Type reference (TYPE) | STRING | 20140327 | |||
| 4 | Importing |
IV_VALUE | Call by reference | Type reference (TYPE) | STRING | 20140327 |
Method CONSTRUCT_AIN_URL on class /AIN/CL_SEARCH_UI_HELPER has no exception.
Method CONVERT_LOCAL_TIMESTAMP Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
EV_TIMESTAMP_UTC | Value transfer | Type reference (TYPE) | TZNTSTMPS | UTC Time Stamp in Short Form (YYYYMMDDhhmmss) | 20061205 | ||
| 2 | Importing |
IV_TIMESTAMP | Call by reference | Type reference (TYPE) | TZNTSTMPS | UTC Time Stamp in Short Form (YYYYMMDDhhmmss) | 20061205 |
Method CONVERT_LOCAL_TIMESTAMP on class /AIN/CL_SEARCH_UI_HELPER has no exception.
Method CREATE_PACK_STRUCTURE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
EV_TABLETYPE | Value transfer | Object reference (TYPE REF TO) | CL_ABAP_TABLEDESCR | Runtime Type Services | 20070207 | ||
| 2 | Importing |
IV_HEADER_STR_NAME | Call by reference | Type reference (TYPE) | DDOBJNAME | Name of ABAP Dictionary Object | 20070118 | ||
| 3 | Importing |
IV_ITEM_CTX_NAME | Call by reference | Type reference (TYPE) | DDOBJNAME | Name of ABAP Dictionary Object | 20070118 |
Method CREATE_PACK_STRUCTURE on class /AIN/CL_SEARCH_UI_HELPER has no exception.
Method CREATE_RETURN_STRUCTURE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IT_ELEMENTS | Call by reference | Type reference (TYPE) | /AIN/PRF_ELEMENT_TAB | Table type for Profile Element structure | 20061130 | ||
| 2 | Importing |
IV_HEADER_STR_NAME | Call by reference | Type reference (TYPE) | DDOBJNAME | Name of ABAP Dictionary Object | 20061130 | ||
| 3 | Importing |
IV_RETURN_STR_NAME | Call by reference | Type reference (TYPE) | DDOBJNAME | Name of ABAP Dictionary Object | 20061201 | ||
| 4 | Importing |
IV_RETURN_TAB_NAME | Call by reference | Type reference (TYPE) | DDOBJNAME | Name of ABAP Dictionary Object | 20061204 |
Method CREATE_RETURN_STRUCTURE on class /AIN/CL_SEARCH_UI_HELPER has no exception.
Method DELETE_RETURN_STRUCTURE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_RETURN_STR_NAME | Call by reference | Type reference (TYPE) | DDOBJNAME | Name of ABAP Dictionary Object | 20061201 | ||
| 2 | Importing |
IV_RETURN_TAB_NAME | Call by reference | Type reference (TYPE) | DDOBJNAME | Name of ABAP Dictionary Object | 20061204 |
Method DELETE_RETURN_STRUCTURE on class /AIN/CL_SEARCH_UI_HELPER has no exception.
Method GET_CTX_ELEMENTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
ET_ELEMENTS | Value transfer | Type reference (TYPE) | /AIN/PRF_ELEMENT_TAB | Table type for Profile Element structure | 20070403 | ||
| 2 | Importing |
IV_ELEMENTSET_USAGE | Call by reference | Type reference (TYPE) | /AIN/PRF_ELEMENTSET_USAGE | Usage of Element Set in Profile | 20070403 | ||
| 3 | Importing |
IV_PROFILE | Call by reference | Type reference (TYPE) | /AIN/PRF_PROFILE | Profile | 20070403 | ||
| 4 | Importing |
IV_PROFILE_TYPE | Call by reference | Type reference (TYPE) | /AIN/PRF_PROFILE_TYPE | Type of Profile | 20070403 |
Method GET_CTX_ELEMENTS on class /AIN/CL_SEARCH_UI_HELPER has no exception.
Method GET_SAP_ALL_FIELDS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
ET_ELEMENTS | Value transfer | Type reference (TYPE) | /AIN/PRF_ELEMENT_TAB | Table type for Profile Element structure | 20061208 |
Method GET_SAP_ALL_FIELDS on class /AIN/CL_SEARCH_UI_HELPER has no exception.
Method IS_CONTEXT_CHANGED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
EV_CHANGED | Value transfer | Type reference (TYPE) | /AIN/UI_BOOL | UI Boolean | 20061201 | ||
| 2 | Importing |
IT_ELEMENTS | Call by reference | Type reference (TYPE) | /AIN/PRF_ELEMENT_TAB | Table type for Profile Element structure | 20061201 | ||
| 3 | Importing |
IV_HEADER_STR_NAME | Call by reference | Type reference (TYPE) | DDOBJNAME | Name of ABAP Dictionary Object | 20070405 | ||
| 4 | Importing |
IV_STRUCTURE_NAME | Call by reference | Type reference (TYPE) | DDOBJNAME | Name of ABAP Dictionary Object | 20061201 |
Method IS_CONTEXT_CHANGED on class /AIN/CL_SEARCH_UI_HELPER has no exception.
History
| Last changed by/on | SAP | 20141109 |
| SAP Release Created in | 510 |
