Interface SubscriptionSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface SubscriptionSearch
extends OsidSearch

The search interface for governing subscription searches.

Method Summary

Modifier and Type	Method	Description
SubscriptionSearchRecord	getSubscriptionSearchRecord(Type subscriptionSearchRecordType)	Gets the subscription search record corresponding to the given subscription search record Type .This method is used to retrieve an object implementing the requested record.
void	orderSubscriptionResults(SubscriptionSearchOrder subscriptionSearchOrder)	Specify an ordering to the search results.
void	searchAmongSubscriptions(IdList subscriptionIds)	Execute this search among the given list of subscriptions.

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

searchAmongSubscriptions

void searchAmongSubscriptions(IdList subscriptionIds)

Execute this search among the given list of subscriptions.

Parameters:

subscriptionIds - list of subscriptions

Throws:

NullArgumentException - subscriptionIds is null

Compliance:

mandatory - This method must be implemented.

orderSubscriptionResults

void orderSubscriptionResults(SubscriptionSearchOrder subscriptionSearchOrder)

Specify an ordering to the search results.

Parameters:

subscriptionSearchOrder - subscription search order

Throws:

NullArgumentException - subscriptionSearchOrder is null

UnsupportedException - subscriptionSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getSubscriptionSearchRecord

SubscriptionSearchRecord getSubscriptionSearchRecord(Type subscriptionSearchRecordType)
                                              throws OperationFailedException

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

Parameters:

subscriptionSearchRecordType - a subscription search record type

Returns:

the subscription search record

Throws:

NullArgumentException - subscriptionSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(subscriptionSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.