/AWS1/CL_IOSSEARCHSUMMARY¶
A summary of a single search as returned by ListSearches.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_searchid TYPE /AWS1/IOSSEARCHID /AWS1/IOSSEARCHID¶
The unique identifier of the search.
iv_workspacename TYPE /AWS1/IOSWORKSPACENAME /AWS1/IOSWORKSPACENAME¶
The name of the workspace the search runs against.
iv_status TYPE /AWS1/IOSSEARCHSTATUS /AWS1/IOSSEARCHSTATUS¶
The current status of the search.
iv_querystatement TYPE /AWS1/IOSSEARCHQUERYSTATEMENT /AWS1/IOSSEARCHQUERYSTATEMENT¶
The natural-language query that was submitted for the search.
iv_searchtype TYPE /AWS1/IOSSEARCHTYPE /AWS1/IOSSEARCHTYPE¶
The search strategy used for the search.
Optional arguments:¶
iv_statusreason TYPE /AWS1/IOSSTRING00 /AWS1/IOSSTRING00¶
A human-readable explanation of the current status. Populated when the search has
FAILED.
iv_startedat TYPE /AWS1/IOSTIMESTAMP00 /AWS1/IOSTIMESTAMP00¶
The time at which the search was started.
iv_groupid TYPE /AWS1/IOSGROUPID /AWS1/IOSGROUPID¶
The group identifier associated with the search, if one was supplied on the request.
Queryable Attributes¶
searchId¶
The unique identifier of the search.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SEARCHID() |
Getter for SEARCHID, with configurable default |
ASK_SEARCHID() |
Getter for SEARCHID w/ exceptions if field has no value |
HAS_SEARCHID() |
Determine if SEARCHID has a value |
workspaceName¶
The name of the workspace the search runs against.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_WORKSPACENAME() |
Getter for WORKSPACENAME, with configurable default |
ASK_WORKSPACENAME() |
Getter for WORKSPACENAME w/ exceptions if field has no value |
HAS_WORKSPACENAME() |
Determine if WORKSPACENAME has a value |
status¶
The current status of the search.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUS() |
Getter for STATUS, with configurable default |
ASK_STATUS() |
Getter for STATUS w/ exceptions if field has no value |
HAS_STATUS() |
Determine if STATUS has a value |
queryStatement¶
The natural-language query that was submitted for the search.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_QUERYSTATEMENT() |
Getter for QUERYSTATEMENT, with configurable default |
ASK_QUERYSTATEMENT() |
Getter for QUERYSTATEMENT w/ exceptions if field has no valu |
HAS_QUERYSTATEMENT() |
Determine if QUERYSTATEMENT has a value |
searchType¶
The search strategy used for the search.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SEARCHTYPE() |
Getter for SEARCHTYPE, with configurable default |
ASK_SEARCHTYPE() |
Getter for SEARCHTYPE w/ exceptions if field has no value |
HAS_SEARCHTYPE() |
Determine if SEARCHTYPE has a value |
statusReason¶
A human-readable explanation of the current status. Populated when the search has
FAILED.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUSREASON() |
Getter for STATUSREASON, with configurable default |
ASK_STATUSREASON() |
Getter for STATUSREASON w/ exceptions if field has no value |
HAS_STATUSREASON() |
Determine if STATUSREASON has a value |
startedAt¶
The time at which the search was started.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STARTEDAT() |
Getter for STARTEDAT, with configurable default |
ASK_STARTEDAT() |
Getter for STARTEDAT w/ exceptions if field has no value |
HAS_STARTEDAT() |
Determine if STARTEDAT has a value |
groupId¶
The group identifier associated with the search, if one was supplied on the request.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_GROUPID() |
Getter for GROUPID, with configurable default |
ASK_GROUPID() |
Getter for GROUPID w/ exceptions if field has no value |
HAS_GROUPID() |
Determine if GROUPID has a value |
Public Local Types In This Class¶
Internal table types, representing arrays and maps of this class, are defined as local types:
TT_SEARCHSUMMARIES¶
TYPES TT_SEARCHSUMMARIES TYPE STANDARD TABLE OF REF TO /AWS1/CL_IOSSEARCHSUMMARY WITH DEFAULT KEY
.