Interface ProvisionSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface ProvisionSearch
extends OsidSearch

The search interface for governing provision searches.

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.

Methods inherited from interface OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongProvisions

void searchAmongProvisions(IdList provisionIds)

Execute this search among the given list of provisions.

Parameters:

provisionIds - list of provisions

Throws:

NullArgumentException - provisionIds is null

Compliance:

mandatory - This method must be implemented.

orderProvisionResults

void orderProvisionResults(ProvisionSearchOrder provisionSearchOrder)

Specify an ordering to the search results.

Parameters:

provisionSearchOrder - provision search order

Throws:

NullArgumentException - provisionSearchOrder is null

UnsupportedException - provisionSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getProvisionSearchRecord

ProvisionSearchRecord getProvisionSearchRecord(Type provisionSearchRecordType)
                                        throws OperationFailedException

Gets the provision search record corresponding to the given provision search record Type. This method is used to retrieve an object implementing the requested record.

Parameters:

provisionSearchRecordType - a provision search record type

Returns:

the provision search record

Throws:

NullArgumentException - provisionSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(provisionSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.