SAP ABAP Class CL_HCS_REQUEST (Help Center Search: Search Request)
Hierarchy
☛
SAP_UI (Software Component) User Interface Technology
⤷ BC-HLP-ABA (Application Component) Help Infrastructure for ABAP
⤷ SWDP_HELP_CENTER (Package) Help Center ABAP Web Dynpro
⤷ BC-HLP-ABA (Application Component) Help Infrastructure for ABAP
⤷ SWDP_HELP_CENTER (Package) Help Center ABAP Web Dynpro
Properties
Class | CL_HCS_REQUEST | |
Short Description | Help Center Search: Search Request | |
Super Class | ||
Instantiability of a Class | 2 | Public |
Final |
General Data
Message Class | ||
Program status | ||
Category | 0 | |
Package | SWDP_HELP_CENTER | Help Center ABAP Web Dynpro |
Created | 20100215 | 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_HCS_REQUEST has no interface implemented.
Friends
Class CL_HCS_REQUEST has no friend class.
Attributes
# | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | M_REQUEST | Instance attribute | Private | Object reference (TYPE REF TO) | CL_ESH_IF_SEARCH_REQUEST | Enterprise Search: Request | 20100222 |
Methods
# | Method | Level | Visibility | Method type | Description | Created on |
---|---|---|---|---|---|---|
1 | CONSTRUCTOR | Instance method | Public | Constructor | CONSTRUCTOR | 20100222 |
2 | GET_ESH_REQUEST | Instance method | Public | Method | Get Enterprise Search Search Request | 20100222 |
3 | SEARCH_FEDERATED | Instance method | Public | Method | Search | 20100222 |
4 | SET_MAX_NUMBER_OF_RESULTS | Instance method | Public | Method | Set Maximum Number of Results | 20100222 |
5 | SET_QUERY_PARTS | Instance method | Public | Method | Set Query Parts | 20100222 |
6 | SET_SEARCH_MODE | Instance method | Public | Method | Set Search Mode | 20100222 |
7 | SET_SEARCH_SCOPE | Instance method | Public | Method | Set Search Scope | 20100222 |
8 | SET_SEARCH_TEXT | Instance method | Public | Method | Set Search Text | 20100222 |
9 | SET_START_INDEX | Instance method | Public | Method | Set Start Index | 20100222 |
Events
Class CL_HCS_REQUEST has no event.
Types
Class CL_HCS_REQUEST has no local type.
Method Signatures
Method CONSTRUCTOR Signature
Method CONSTRUCTOR on class CL_HCS_REQUEST has no parameter.
Method CONSTRUCTOR on class CL_HCS_REQUEST has no exception.
Method GET_ESH_REQUEST Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Returning | R_ESH_REQUEST | Value transfer | Object reference (TYPE REF TO) | CL_ESH_IF_SEARCH_REQUEST | Enterprise Search Suchrequest | 20100222 |
Method GET_ESH_REQUEST on class CL_HCS_REQUEST has no exception.
Method SEARCH_FEDERATED Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | I_SORT_BY_RANK | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Nach Ranking sortieren? | 20100222 | |
2 | Returning | R_RESPONSES | Value transfer | Object reference (TYPE REF TO) | CL_ESH_IF_SEARCH_RESPONSES | Suchergebnisse | 20100222 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_ESH_IF_ENGINE | ESH Interface Exception | 20100222 |
Method SET_MAX_NUMBER_OF_RESULTS Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | I_MAX_NUMBER_OF_RESULTS | Call by reference | Type reference (TYPE) | I | 100 | Maximale Anzahl der Ergebnisse | 20100222 |
Method SET_MAX_NUMBER_OF_RESULTS on class CL_HCS_REQUEST has no exception.
Method SET_QUERY_PARTS Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | I_QUERY_PART | Call by reference | Object reference (TYPE REF TO) | CL_HCS_QUERY_PART | Help Center Suche: Teilanfrage | 20100222 |
Method SET_QUERY_PARTS on class CL_HCS_REQUEST has no exception.
Method SET_SEARCH_MODE Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | I_MODE | Call by reference | Type reference (TYPE) | CHAR1 | Suchmodus | 20100222 |
Method SET_SEARCH_MODE on class CL_HCS_REQUEST has no exception.
Method SET_SEARCH_SCOPE Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | I_SCOPE_CATEGORY | Call by reference | Type reference (TYPE) | CHAR30 | Scopekategorie | 20100222 |
Method SET_SEARCH_SCOPE on class CL_HCS_REQUEST has no exception.
Method SET_SEARCH_TEXT Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | I_TEXT | Call by reference | Type reference (TYPE) | STRING | Suchtext | 20100222 |
Method SET_SEARCH_TEXT on class CL_HCS_REQUEST has no exception.
Method SET_START_INDEX Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | I_START_INDEX | Call by reference | Type reference (TYPE) | I | Startindex | 20100222 |
Method SET_START_INDEX on class CL_HCS_REQUEST has no exception.
History
Last changed by/on | SAP | 20110908 |
SAP Release Created in |