Interface | osid.subscription.SubscriptionQuery | ||
---|---|---|---|
Implements | osid.OsidRelationshipQuery | ||
Description |
This is the query for searching subscriptions. Each method
specifies an | ||
Method | matchDispatchId | ||
Description |
Sets the dispatch | ||
Parameters | osid.id.Id | dispatchId | a dispatch Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | dispatchId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearDispatchIdTerms | ||
Description |
Clears the dispatch | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsDispatchQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a dispatch query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getDispatchQuery | ||
Description |
Gets the query for a dispatch query. Multiple
retrievals produce a nested | ||
Return | osid.subscription.DispatchQuery | the dispatch query | |
Errors | UNIMPLEMENTED | supportsDispatchQuery() is false | |
Compliance | optional | This method must be implemented if supportsDispatchQuery()
is true. | |
Method | clearDispatchTerms | ||
Description |
Clears the dispatch terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchSubscriberId | ||
Description |
Sets a subscriber | ||
Parameters | osid.id.Id | resourceId | a resource Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | resourceId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearSubscriberIdTerms | ||
Description |
Clears the subscriber | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsSubscriberQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a resource query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getSubscriberQuery | ||
Description |
Gets the query for a subscriber query. Multiple
retrievals produce a nested | ||
Return | osid.resource.ResourceQuery | the resource query | |
Errors | UNIMPLEMENTED | supportsSubscriberQuery() is false | |
Compliance | optional | This method must be implemented if supportsSubscriberQuery()
is true. | |
Method | clearSubscriberTerms | ||
Description |
Clears the subscriber terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAddressId | ||
Description |
Sets an address | ||
Parameters | osid.id.Id | addressId | an address Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | addressId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearAddressIdTerms | ||
Description |
Clears the address | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsAddressQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an address query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getAddressQuery | ||
Description |
Gets the query for an address query. Multiple
retrievals produce a nested | ||
Return | osid.contact.AddressQuery | the address query | |
Errors | UNIMPLEMENTED | supportsAddressQuery() is false | |
Compliance | optional | This method must be implemented if supportsAddressrQuery()
is true. | |
Method | matchAnyAddress | ||
Description |
Matches any address. | ||
Parameters | boolean | match | true for a positive match, false for a
negative match |
Compliance | mandatory | This method must be implemented. | |
Method | clearAddressTerms | ||
Description |
Clears the address 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 | getSubscriptionQueryRecord | ||
Description |
Gets the subscription query record corresponding to the
given | ||
Parameters | osid.type.Type | subscriptionRecordType | a subscription record type |
Return | osid.subscription.records.SubscriptionQueryRecord | the subscription query record | |
Errors | NULL_ARGUMENT | subscriptionRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(subscriptionRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |