Interface | osid.subscription.SubscriptionSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing subscription searches. | ||
Method | searchAmongSubscriptions | ||
Description |
Execute this search among the given list of subscriptions. | ||
Parameters | osid.id.IdList | subscriptionIds | list of subscriptions |
Errors | NULL_ARGUMENT | subscriptionIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderSubscriptionResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.subscription.SubscriptionSearchOrder | subscriptionSearchOrder | subscription search order |
Errors | NULL_ARGUMENT | subscriptionSearchOrder is null | |
UNSUPPORTED | subscriptionSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSubscriptionSearchRecord | ||
Description |
Gets the subscription search record corresponding to
the given subscription search record | ||
Parameters | osid.type.Type | subscriptionSearchRecordType | a subscription search record type |
Return | osid.subscription.records.SubscriptionSearchRecord | the subscription search record | |
Errors | NULL_ARGUMENT | subscriptionSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(subscriptionSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |