Interface | osid.subscription.DispatchQuery | ||
---|---|---|---|
Implements | osid.OsidGovernatorQuery | ||
Description |
This is the query for searching for dispatches. Each method
specifies an | ||
Method | matchAddressGenusType | ||
Description |
Matches an address genus | ||
Parameters | osid.type.Type | addressGenusType | an address genus Type |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | addressGenusType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyAddressGenusType | ||
Description |
Matches dispatches with any address genus type. | ||
Parameters | boolean | match | true to match dispatches with any addres sgenus type,
false to match dispatches with no address genus types |
Compliance | mandatory | This method must be implemented. | |
Method | clearAddressGenusTypeTerms | ||
Description |
Clears the address genus | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchSubscriptionId | ||
Description |
Sets the subscription | ||
Parameters | osid.id.Id | subscriptionId | a subscription Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | subscriptionId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearSubscriptionIdTerms | ||
Description |
Clears the subscription | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsSubscriptionQuery | ||
Description |
Tests if a subscription query is available. | ||
Return | boolean | true if a subscription query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getSubscriptionQuery | ||
Description |
Gets the query for a dispatch. | ||
Return | osid.subscription.SubscriptionQuery | the subscription query | |
Errors | UNIMPLEMENTED | supportsSubscriptionQuery() is false | |
Compliance | optional | This method must be implemented if supportsSubscriptionQuery()
is true. | |
Method | matchAnySubscription | ||
Description |
Matches dispatches with any subscription. | ||
Parameters | boolean | match | true to match dispatches with any subscription, false
to match dispatches with no subscriptions |
Compliance | mandatory | This method must be implemented. | |
Method | clearSubscriptionTerms | ||
Description |
Clears the subscription terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchPublisherId | ||
Description |
Sets the dispatch | ||
Parameters | osid.id.Id | publisherId | a publisher Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | publisherId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearPublisherIdTerms | ||
Description |
Clears the publisher | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsPublisherQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a publisher query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getPublisherQuery | ||
Description |
Gets the query for a publisher query. Multiple
retrievals produce a nested | ||
Return | osid.subscription.PublisherQuery | the publisher query | |
Errors | UNIMPLEMENTED | supportsPublisherQuery() is false | |
Compliance | optional | This method must be implemented if supportsPublisherQuery()
is true. | |
Method | clearPublisherTerms | ||
Description |
Clears the publisher terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDispatchQueryRecord | ||
Description |
Gets the dispatch query record corresponding to the
given | ||
Parameters | osid.type.Type | dispatchRecordType | a dispatch record type |
Return | osid.subscription.records.DispatchQueryRecord | the dispatch query record | |
Errors | NULL_ARGUMENT | dispatchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(dispatchRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |