Interface SubscriptionSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface SubscriptionSearchResults
extends OsidSearchResults

This interface provides a means to capture results of a search.

Method Summary

Modifier and Type	Method	Description
SubscriptionQueryInspector	getSubscriptionQueryInspector()	Gets the inspector for the query to examine the terns used in the search.
SubscriptionList	getSubscriptions()	Gets the subscription list resulting from a search.
SubscriptionSearchResultsRecord	getSubscriptionSearchResultsRecord(Type subscriptionSearchRecordType)	Gets the subscription search results record corresponding to the given subscription search record Type .This method must be used to retrieve an object implementing the requested record.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

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 OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

getSubscriptions

SubscriptionList getSubscriptions()

Gets the subscription list resulting from a search.

Returns:

the subscription list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getSubscriptionQueryInspector

SubscriptionQueryInspector getSubscriptionQueryInspector()

Gets the inspector for the query to examine the terns used in the search.

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getSubscriptionSearchResultsRecord

SubscriptionSearchResultsRecord getSubscriptionSearchResultsRecord(Type subscriptionSearchRecordType)
                                                            throws OperationFailedException

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

Parameters:

subscriptionSearchRecordType - a subscription search record type

Returns:

the subscription search results record

Throws:

NullArgumentException - subscriptionSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(subscriptionSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.