Interface ProvisionEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface ProvisionEnablerSearch
extends OsidSearch

The search interface for governing provision enabler searches.

Method Summary

Modifier and Type	Method	Description
ProvisionEnablerSearchRecord	getProvisionEnablerSearchRecord(Type provisionEnablerSearchRecordType)	Gets the provision enabler search record corresponding to the given provision enabler search record Type .This method is used to retrieve an object implementing the requested record.
void	orderProvisionEnablerResults(ProvisionEnablerSearchOrder provisionEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongProvisionEnablers(IdList provisionEnablerIds)	Execute this search among the given list of provision 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

searchAmongProvisionEnablers

void searchAmongProvisionEnablers(IdList provisionEnablerIds)

Execute this search among the given list of provision enablers.

Parameters:

provisionEnablerIds - list of provision enablers

Throws:

NullArgumentException - provisionEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderProvisionEnablerResults

void orderProvisionEnablerResults(ProvisionEnablerSearchOrder provisionEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

provisionEnablerSearchOrder - provision enabler search order

Throws:

NullArgumentException - provisionEnablerSearchOrder is null

UnsupportedException - provisionEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getProvisionEnablerSearchRecord

ProvisionEnablerSearchRecord getProvisionEnablerSearchRecord(Type provisionEnablerSearchRecordType)
                                                      throws OperationFailedException

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

Parameters:

provisionEnablerSearchRecordType - a provision enabler search record type

Returns:

the provision enabler search record

Throws:

NullArgumentException - provisionEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(provisionEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.