public interface RequestSearch extends OsidSearch
The search interface for governing request searches.
Modifier and Type | Method and Description |
---|---|
RequestSearchRecord |
getRequestSearchRecord(Type requestSearchRecordType)
Gets the request search record corresponding to the given request
search record
Type. |
void |
orderRequestResults(RequestSearchOrder requestSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongRequests(IdList requestIds)
Execute this search among the given list of requests.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongRequests(IdList requestIds)
requestIds
- list of requestsNullArgumentException
- requestIds
is
null
mandatory
- This method must be implemented. void orderRequestResults(RequestSearchOrder requestSearchOrder)
requestSearchOrder
- request search orderNullArgumentException
- requestSearchOrder
is null
UnsupportedException
- requestSearchOrder
is not of this servicemandatory
- This method must be implemented. RequestSearchRecord getRequestSearchRecord(Type requestSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an
object implementing the requested record.requestSearchRecordType
- a request search record typeNullArgumentException
- requestSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(requestSearchRecordType)
is false
mandatory
- This method must be implemented.