Interface CommissionEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface CommissionEnablerSearch
extends OsidSearch

The search interface for governing commission enabler searches.

Method Summary

Modifier and Type	Method	Description
CommissionEnablerSearchRecord	getCommissionEnablerSearchRecord(Type commissionEnablerSearchRecordType)	Gets the commission enabler search record corresponding to the given commission enabler search record Type .This method is used to retrieve an object implementing the requested record.
void	orderCommissionEnablerResults(CommissionEnablerSearchOrder commissionEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongCommissionEnablers(IdList foundryIds)	Execute this search among the given list of commission 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

searchAmongCommissionEnablers

void searchAmongCommissionEnablers(IdList foundryIds)

Execute this search among the given list of commission enablers.

Parameters:

foundryIds - list of commission enablers

Throws:

NullArgumentException - foundryIds is null

Compliance:

mandatory - This method must be implemented.

orderCommissionEnablerResults

void orderCommissionEnablerResults(CommissionEnablerSearchOrder commissionEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

commissionEnablerSearchOrder - commission enabler search order

Throws:

NullArgumentException - commissionEnablerSearchOrder is null

UnsupportedException - commissionEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getCommissionEnablerSearchRecord

CommissionEnablerSearchRecord getCommissionEnablerSearchRecord(Type commissionEnablerSearchRecordType)
                                                        throws OperationFailedException

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

Parameters:

commissionEnablerSearchRecordType - a commission enabler search record type

Returns:

the commission enabler search record

Throws:

NullArgumentException - commissionEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(commissionEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.