public interface RequisiteSearch extends OsidSearch
The search interface for governing requisite searches.
Modifier and Type | Method and Description |
---|---|
RequisiteSearchRecord |
getRequisiteSearchRecord(Type requisiteSearchRecordType)
Gets the requisite search record corresponding to the given requisite
search record
Type. |
void |
orderRequisiteResults(RequisiteSearchOrder requisiteSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongRequisites(IdList requisiteIds)
Execute this search among the given list of requisites.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongRequisites(IdList requisiteIds)
requisiteIds
- list of requisite Ids
NullArgumentException
- requisiteIds
is
null
mandatory
- This method must be implemented. void orderRequisiteResults(RequisiteSearchOrder requisiteSearchOrder)
requisiteSearchOrder
- requisite search orderNullArgumentException
- requisiteSearchOrder
is null
UnsupportedException
- requisiteSearchOrder
is not of this servicemandatory
- This method must be implemented. RequisiteSearchRecord getRequisiteSearchRecord(Type requisiteSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an
object implementing the requested record.requisiteSearchRecordType
- a requisite search record typeNullArgumentException
-
requisiteSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(requisiteSearchRecordType)
is
false
mandatory
- This method must be implemented.