Interface SubscriptionEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface SubscriptionEnablerSearch
extends OsidSearch

The search interface for governing subscription enabler searches.

Method Summary

Modifier and Type	Method	Description
SubscriptionEnablerSearchRecord	getSubscriptionEnablerSearchRecord(Type subscriptionEnablerSearchRecordType)	Gets the subscription enabler search record corresponding to the given subscription enabler search record Type .
void	orderSubscriptionEnablerResults(SubscriptionEnablerSearchOrder subscriptionEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongSubscriptionEnablers(IdList subscriptionEnablerIds)	Execute this search among the given list of subscription 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

searchAmongSubscriptionEnablers

void searchAmongSubscriptionEnablers(IdList subscriptionEnablerIds)

Execute this search among the given list of subscription enablers.

Parameters:

subscriptionEnablerIds - list of subscription enablers

Throws:

NullArgumentException - subscriptionEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderSubscriptionEnablerResults

void orderSubscriptionEnablerResults(SubscriptionEnablerSearchOrder subscriptionEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

subscriptionEnablerSearchOrder - subscription enabler search order

Throws:

NullArgumentException - subscriptionEnablerSearchOrder is null

UnsupportedException - subscriptionEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getSubscriptionEnablerSearchRecord

SubscriptionEnablerSearchRecord getSubscriptionEnablerSearchRecord(Type subscriptionEnablerSearchRecordType)
                                                            throws OperationFailedException

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

Parameters:

subscriptionEnablerSearchRecordType - a subscription enabler search record type

Returns:

the subscription enabler search record

Throws:

NullArgumentException - subscriptionEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(subscriptionEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.