SAP ABAP Class CL_ESH_CM_TERM_SUGGESTIONS (Public API for Search Term Suggestions)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
⤷
S_ESH_ENG_IF_CONTENT_MGT (Package) Enterprise Search - Content Management
SAP_BASIS (Software Component) SAP Basis Component⤷
BC-EIM-ESH (Application Component) NetWeaver Enterprise Search⤷
S_ESH_ENG_IF_CONTENT_MGT (Package) Enterprise Search - Content ManagementProperties
| Class | CL_ESH_CM_TERM_SUGGESTIONS | |
| Short Description | Public API for Search Term Suggestions | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | S_ESH_ENG_IF_CONTENT_MGT | Enterprise Search - Content Management |
| Created | 20100310 | SAP |
| Last change | 20110908 | 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) |
Interfaces
Class CL_ESH_CM_TERM_SUGGESTIONS has no interface implemented.
Friends
Class CL_ESH_CM_TERM_SUGGESTIONS has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | GC_EXCLUSION_TYPE_PATTERN |
Constant | Public | Type reference (TYPE) | ESH_E_CM_EXCL_STRING_TYPE | 'P' | Exclusion type: Pattern | 20100401 | |
| 2 | GC_EXCLUSION_TYPE_REGEX |
Constant | Public | Type reference (TYPE) | ESH_E_CM_EXCL_STRING_TYPE | 'R' | Exclusion type: Regular expression | 20100401 | |
| 3 | GC_EXCLUSION_TYPE_TERM |
Constant | Public | Type reference (TYPE) | ESH_E_CM_EXCL_STRING_TYPE | '' | Exclusion type: Term | 20100401 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | GET_APPLICATIONS |
Static method | Public | Method | Get content manager applications | 20100408 |
| 2 | GET_SUGGESTIONS |
Static method | Public | Method | Get search term suggestions | 20100310 |
| 3 | SET_SUGGESTIONS |
Static method | Public | Method | Set search term suggestions | 20100310 |
Events
Class CL_ESH_CM_TERM_SUGGESTIONS has no event.
Types
Class CL_ESH_CM_TERM_SUGGESTIONS has no local type.
Method Signatures
Method GET_APPLICATIONS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
ET_CM_APPLICATIONS | Call by reference | Type reference (TYPE) | ESH_T_CM_CONTENT_MANAGER_APPL | Content Manager Application | 20100408 | ||
| 2 |  Importing |
IV_LANGU | Call by reference | Type reference (TYPE) | SPRAS | Language Key | 20100408 |
Method GET_APPLICATIONS on class CL_ESH_CM_TERM_SUGGESTIONS has no exception.
Method GET_SUGGESTIONS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_SUGGESTED_TERMS | Call by reference | Type reference (TYPE) | ESH_T_CM_TERMS_WITH_RANK_WGHTD | Character Field Length 1 | 20100312 | ||
| 2 | Importing |
IT_SCOPE_FILTER | Call by reference | Type reference (TYPE) | ESH_T_CM_SCOPE | Scope Item Filter | 20100312 | ||
| 3 | Importing |
IT_TERM_FILTER | Call by reference | Type reference (TYPE) | ESH_T_CM_TERM_FILTER | Term Filter | 20100408 | ||
| 4 | Importing |
IV_CONTENT_MGR_APPL | Call by reference | Type reference (TYPE) | ESH_E_CM_CONTENT_MGR_APPL | Content Manager Application (Classname) | 20100329 | ||
| 5 | Importing |
IV_MANUAL_ENTRIES_ONLY | Call by reference | Type reference (TYPE) | ESH_E_CM_MANUAL_ENTRIES_ONLY | Manual Entries Only | 20100310 | ||
| 6 | Importing |
IV_MAX_ROWS | Call by reference | Type reference (TYPE) | I | 1000 | Max Number of Records | 20100409 |
Method GET_SUGGESTIONS on class CL_ESH_CM_TERM_SUGGESTIONS has no exception.
Method SET_SUGGESTIONS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IO_SUGGESTION_MGR | Call by reference | Object reference (TYPE REF TO) | IF_ESH_CM_SUGGESTION_MANAGER | ESH Content Management: Suggestion Manager | 20100312 | ||
| 2 | Importing |
IV_CHECK_START_CONDITIONS | Call by reference | Type reference (TYPE) | CHAR01 | Call Suggestion Mgr. to check start conditions | 20100726 | ||
| 3 | Importing |
IV_RETRIEVE_EXCLUDED_TERMS | Call by reference | Type reference (TYPE) | CHAR01 | ABAP_TRUE | Retrieve Excluded Terms | 20100312 | |
| 4 | Importing |
IV_RETRIEVE_SUGGESTED_TERMS | Call by reference | Type reference (TYPE) | CHAR01 | ABAP_TRUE | Retrieve Suggested Terms | 20100312 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_ESH_CM_CONTENT_MANAGEMENT |
Generic Exception: ESH Content Management | 20100804 | |
| 2 | CX_ESH_CM_IS_LOCKED |
Content Management: Process Is Locked | 20100726 | |
| 3 | CX_ESH_CM_NOT_AUTHORIZED |
Content Management: Not Authorized | 20100804 |
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in | 730 |
