public interface CheckSearch extends OsidSearch
The search interface for governing check searches.
Modifier and Type | Method and Description |
---|---|
CheckSearchRecord |
getCheckSearchRecord(Type checkSearchRecordType)
Gets the check search record corresponding to the given check search
record
Type. |
void |
orderCheckResults(CheckSearchOrder checkSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongChecks(IdList checkIds)
Execute this search among the given list of checks.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongChecks(IdList checkIds)
checkIds
- list of checksNullArgumentException
- checkIds
is
null
mandatory
- This method must be implemented. void orderCheckResults(CheckSearchOrder checkSearchOrder)
checkSearchOrder
- check search orderNullArgumentException
- checkSearchOrder
is null
UnsupportedException
- checkSearchOrder
is not of this servicemandatory
- This method must be implemented. CheckSearchRecord getCheckSearchRecord(Type checkSearchRecordType) throws OperationFailedException, PermissionDeniedException
Type.
This method is used to retrieve an object
implementing the requested record.checkSearchRecordType
- a check search record typeNullArgumentException
- checkSearchRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
hasRecordType(checkSearchRecordType)
is false
mandatory
- This method must be implemented.