Interface ProvisionableEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface ProvisionableEnablerSearch
extends OsidSearch

The search interface for governing provisionable enabler searches.

Method Summary

Modifier and Type	Method	Description
ProvisionableEnablerSearchRecord	getProvisionableEnablerSearchRecord(Type provisionableEnablerSearchRecordType)	Gets the provisionable enabler search record corresponding to the given provisionable enabler search record Type .
void	orderProvisionableEnablerResults(ProvisionableEnablerSearchOrder provisionableEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongProvisionableEnablers(IdList provisionableEnablerIds)	Execute this search among the given list of provisionable enablers.

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

searchAmongProvisionableEnablers

void searchAmongProvisionableEnablers(IdList provisionableEnablerIds)

Execute this search among the given list of provisionable enablers.

Parameters:

provisionableEnablerIds - list of provisionable enablers

Throws:

NullArgumentException - provisionableEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderProvisionableEnablerResults

void orderProvisionableEnablerResults(ProvisionableEnablerSearchOrder provisionableEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

provisionableEnablerSearchOrder - provisionable enabler search order

Throws:

NullArgumentException - provisionableEnablerSearchOrder is null

UnsupportedException - provisionableEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getProvisionableEnablerSearchRecord

ProvisionableEnablerSearchRecord getProvisionableEnablerSearchRecord(Type provisionableEnablerSearchRecordType)
                                                              throws OperationFailedException

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

Parameters:

provisionableEnablerSearchRecordType - a provisionable enabler search record type

Returns:

the provisionable enabler search record

Throws:

NullArgumentException - provisionableEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(provisionableEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.