OSID Logo
OSID Specifications
subscription package
Version 3.0.0
Release Candidate Preview
Interfaceosid.subscription.DispatchQuery
Implementsosid.OsidGovernatorQuery
Description

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

MethodmatchAddressGenusType
Description

Matches an address genus Type accepted by a dispatch.

Parametersosid.type.TypeaddressGenusTypean address genus Type
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT addressGenusType is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyAddressGenusType
Description

Matches dispatches with any address genus type.

Parametersbooleanmatch true to match dispatches with any addres sgenus type, false to match dispatches with no address genus types
CompliancemandatoryThis method must be implemented.
MethodclearAddressGenusTypeTerms
Description

Clears the address genus Type terms.

CompliancemandatoryThis method must be implemented.
MethodmatchSubscriptionId
Description

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

Parametersosid.id.IdsubscriptionIda subscription Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT subscriptionId is null
CompliancemandatoryThis method must be implemented.
MethodclearSubscriptionIdTerms
Description

Clears the subscription Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsSubscriptionQuery
Description

Tests if a subscription query is available.

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

Gets the query for a dispatch.

Returnosid.subscription.SubscriptionQuerythe subscription query
ErrorsUNIMPLEMENTED supportsSubscriptionQuery() is false
ComplianceoptionalThis method must be implemented if supportsSubscriptionQuery() is true.
MethodmatchAnySubscription
Description

Matches dispatches with any subscription.

Parametersbooleanmatch true to match dispatches with any subscription, false to match dispatches with no subscriptions
CompliancemandatoryThis method must be implemented.
MethodclearSubscriptionTerms
Description

Clears the subscription 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.
MethodgetDispatchQueryRecord
Description

Gets the dispatch query record corresponding to the given Dispatch record Type. Multiple record retrievals produce a nested boolean OR term.

Parametersosid.type.TypedispatchRecordTypea dispatch record type
Returnosid.subscription.records.DispatchQueryRecordthe dispatch query record
ErrorsNULL_ARGUMENT dispatchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(dispatchRecordType) is false
CompliancemandatoryThis method must be implemented.