OSID Logo
OSID Specifications
subscription package
Version 3.0.0
Release Candidate Preview
Interfaceosid.subscription.SubscriptionQuery
Implementsosid.OsidRelationshipQuery
Description

This is the query for searching subscriptions. Each method specifies an AND term while multiple invocations of the same method produce a nested OR.

MethodmatchDispatchId
Description

Sets the dispatch Id for this query to match subscriptions assigned to dispatches.

Parametersosid.id.IddispatchIda dispatch Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT dispatchId is null
CompliancemandatoryThis method must be implemented.
MethodclearDispatchIdTerms
Description

Clears the dispatch Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsDispatchQuery
Description

Tests if a DispatchQuery is available.

Returnboolean true if a dispatch query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetDispatchQuery
Description

Gets the query for a dispatch query. Multiple retrievals produce a nested OR term.

Returnosid.subscription.DispatchQuerythe dispatch query
ErrorsUNIMPLEMENTED supportsDispatchQuery() is false
ComplianceoptionalThis method must be implemented if supportsDispatchQuery() is true.
MethodclearDispatchTerms
Description

Clears the dispatch terms.

CompliancemandatoryThis method must be implemented.
MethodmatchSubscriberId
Description

Sets a subscriber Id.

Parametersosid.id.IdresourceIda resource Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT resourceId is null
CompliancemandatoryThis method must be implemented.
MethodclearSubscriberIdTerms
Description

Clears the subscriber Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsSubscriberQuery
Description

Tests if a ResourceQuery is available.

Returnboolean true if a resource query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetSubscriberQuery
Description

Gets the query for a subscriber query. Multiple retrievals produce a nested OR term.

Returnosid.resource.ResourceQuerythe resource query
ErrorsUNIMPLEMENTED supportsSubscriberQuery() is false
ComplianceoptionalThis method must be implemented if supportsSubscriberQuery() is true.
MethodclearSubscriberTerms
Description

Clears the subscriber terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAddressId
Description

Sets an address Id.

Parametersosid.id.IdaddressIdan address Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT addressId is null
CompliancemandatoryThis method must be implemented.
MethodclearAddressIdTerms
Description

Clears the address Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAddressQuery
Description

Tests if an AddressQuery is available.

Returnboolean true if an address query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAddressQuery
Description

Gets the query for an address query. Multiple retrievals produce a nested OR term.

Returnosid.contact.AddressQuerythe address query
ErrorsUNIMPLEMENTED supportsAddressQuery() is false
ComplianceoptionalThis method must be implemented if supportsAddressrQuery() is true.
MethodmatchAnyAddress
Description

Matches any address.

Parametersbooleanmatch true for a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodclearAddressTerms
Description

Clears the address terms.

CompliancemandatoryThis method must be implemented.
MethodmatchPublisherId
Description

Sets the dispatch Id for this query to match subscriptions assigned to publishers.

Parametersosid.id.IdpublisherIda publisher Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT publisherId is null
CompliancemandatoryThis method must be implemented.
MethodclearPublisherIdTerms
Description

Clears the publisher Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsPublisherQuery
Description

Tests if a PublisherQuery is available.

Returnboolean true if a publisher query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetPublisherQuery
Description

Gets the query for a publisher query. Multiple retrievals produce a nested OR term.

Returnosid.subscription.PublisherQuerythe publisher query
ErrorsUNIMPLEMENTED supportsPublisherQuery() is false
ComplianceoptionalThis method must be implemented if supportsPublisherQuery() is true.
MethodclearPublisherTerms
Description

Clears the publisher terms.

CompliancemandatoryThis method must be implemented.
MethodgetSubscriptionQueryRecord
Description

Gets the subscription query record corresponding to the given Subscription record Type. Multiple record retrievals produce a nested OR term.

Parametersosid.type.TypesubscriptionRecordTypea subscription record type
Returnosid.subscription.records.SubscriptionQueryRecordthe subscription query record
ErrorsNULL_ARGUMENT subscriptionRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(subscriptionRecordType) is false
CompliancemandatoryThis method must be implemented.