public interface ProvisionSearch extends OsidSearch
The search interface for governing provision searches.
Modifier and Type | Method and Description |
---|---|
ProvisionSearchRecord |
getProvisionSearchRecord(Type provisionSearchRecordType)
Gets the provision search record corresponding to the given provision
search record
Type. |
void |
orderProvisionResults(ProvisionSearchOrder provisionSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongProvisions(IdList provisionIds)
Execute this search among the given list of provisions.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongProvisions(IdList provisionIds)
provisionIds
- list of provisionsNullArgumentException
- provisionIds
is
null
mandatory
- This method must be implemented. void orderProvisionResults(ProvisionSearchOrder provisionSearchOrder)
provisionSearchOrder
- provision search orderNullArgumentException
- provisionSearchOrder
is null
UnsupportedException
- provisionSearchOrder
is not of this servicemandatory
- This method must be implemented. ProvisionSearchRecord getProvisionSearchRecord(Type provisionSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an
object implementing the requested record.provisionSearchRecordType
- a provision search record typeNullArgumentException
-
provisionSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(provisionSearchRecordType)
is
false
mandatory
- This method must be implemented.