Interface ProvisionableSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface ProvisionableSearch
extends OsidSearch

The search interface for governing provisionable searches.

Method Summary

Modifier and Type	Method	Description
ProvisionableSearchRecord	getProvisionableSearchRecord(Type provisionableSearchRecordType)	Gets the provisionable search record corresponding to the given provisionable search record Type .This method is used to retrieve an object implementing the requested record.
void	orderProvisionableResults(ProvisionableSearchOrder provisionableSearchOrder)	Specify an ordering to the search results.
void	searchAmongProvisionables(IdList provisionableIds)	Execute this search among the given list of provisionables.

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

searchAmongProvisionables

void searchAmongProvisionables(IdList provisionableIds)

Execute this search among the given list of provisionables.

Parameters:

provisionableIds - list of provisionables

Throws:

NullArgumentException - provisionableIds is null

Compliance:

mandatory - This method must be implemented.

orderProvisionableResults

void orderProvisionableResults(ProvisionableSearchOrder provisionableSearchOrder)

Specify an ordering to the search results.

Parameters:

provisionableSearchOrder - provisionable search order

Throws:

NullArgumentException - provisionableSearchOrder is null

UnsupportedException - provisionableSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getProvisionableSearchRecord

ProvisionableSearchRecord getProvisionableSearchRecord(Type provisionableSearchRecordType)
                                                throws OperationFailedException

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

Parameters:

provisionableSearchRecordType - a provisionable search record type

Returns:

the provisionable search interface

Throws:

NullArgumentException - provisionableSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(provisionableSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.