OSID Logo
OSID Specifications
subscription package
Version 3.0.0
Release Candidate Preview
Interfaceosid.subscription.SubscriptionSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetSubscriptions
Description

Gets the subscription list resulting from a search.

Returnosid.subscription.SubscriptionListthe subscription list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetSubscriptionQueryInspector
Description

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

Returnosid.subscription.SubscriptionQueryInspectorthe query inspector
CompliancemandatoryThis method must be implemented.
MethodgetSubscriptionSearchResultsRecord
Description

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.

Parametersosid.type.TypesubscriptionSearchRecordTypea subscription search record type
Returnosid.subscription.records.SubscriptionSearchResultsRecordthe subscription search results record
ErrorsNULL_ARGUMENT subscriptionSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(subscriptionSearchRecordType) is false
CompliancemandatoryThis method must be implemented.