org.osid.subscription

Interface DispatchQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidGovernatorQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidOperableQuery, OsidQuery, OsidSourceableQuery, Suppliable

public interface DispatchQuery
extends OsidGovernatorQuery

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.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearAddressGenusTypeTerms() Clears the address genus Type terms.
void	clearPublisherIdTerms() Clears the publisher Id terms.
void	clearPublisherTerms() Clears the publisher terms.
void	clearSubscriptionIdTerms() Clears the subscription Id terms.
void	clearSubscriptionTerms() Clears the subscription terms.
DispatchQueryRecord	getDispatchQueryRecord(Type dispatchRecordType) Gets the dispatch query record corresponding to the given Dispatch record Type.
PublisherQuery	getPublisherQuery() Gets the query for a publisher query.
SubscriptionQuery	getSubscriptionQuery() Gets the query for a dispatch.
void	matchAddressGenusType(Type addressGenusType, boolean match) Matches an address genus Type accepted by a dispatch.
void	matchAnyAddressGenusType(boolean match) Matches dispatches with any address genus type.
void	matchAnySubscription(boolean match) Matches dispatches with any subscription.
void	matchPublisherId(Id publisherId, boolean match) Sets the dispatch Id for this query to match subscriptions assigned to publishers.
void	matchSubscriptionId(Id subscriptionId, boolean match) Sets the subscription Id for this query to match subscriptions assigned to dispatches.
boolean	supportsPublisherQuery() Tests if a PublisherQuery is available.
boolean	supportsSubscriptionQuery() Tests if a subscription query is available.

Methods inherited from interface org.osid.OsidObjectQuery

clearCommentIdTerms, clearCommentTerms, clearCreditIdTerms, clearCreditTerms, clearDescriptionTerms, clearDisplayNameTerms, clearGenusTypeTerms, clearJournalEntryIdTerms, clearJournalEntryTerms, clearParentGenusTypeTerms, clearRelationshipIdTerms, clearRelationshipPeerIdTerms, clearRelationshipTerms, clearStateIdTerms, clearStateTerms, clearStatisticTerms, clearSubjectIdTerms, clearSubjectRelevancyTerms, clearSubjectTerms, getCommentQuery, getCreditQuery, getJournalEntryQuery, getRelationshipQuery, getStateQuery, getStatisticQuery, getSubjectQuery, getSubjectRelevancyQuery, matchAnyComment, matchAnyCredit, matchAnyDescription, matchAnyDisplayName, matchAnyGenusType, matchAnyJournalEntry, matchAnyRelationship, matchAnyState, matchAnyStatistic, matchAnySubject, matchCommentId, matchCreditId, matchDescription, matchDisplayName, matchGenusType, matchJournalEntryId, matchParentGenusType, matchRelationshipId, matchRelationshipPeerId, matchStateId, matchSubjectId, supportsCommentQuery, supportsCreditQuery, supportsJournalEntryQuery, supportsRelationshipQuery, supportsStateQuery, supportsStatisticQuery, supportsSubjectQuery, supportsSubjectRelevancyQuery

Methods inherited from interface org.osid.OsidIdentifiableQuery

clearIdTerms, matchId

Methods inherited from interface org.osid.OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Methods inherited from interface org.osid.OsidOperableQuery

clearActiveTerms, clearDisabledTerms, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational

Methods inherited from interface org.osid.OsidSourceableQuery

clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery

Method Detail

matchAddressGenusType

void matchAddressGenusType(Type addressGenusType,
                         boolean match)

Matches an address genus Type accepted by a dispatch.

Parameters:

addressGenusType - an address genus Type

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - addressGenusType is null

Compliance:

mandatory - This method must be implemented.

matchAnyAddressGenusType

void matchAnyAddressGenusType(boolean match)

Matches dispatches with any address genus type.

Parameters:

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.

clearAddressGenusTypeTerms

void clearAddressGenusTypeTerms()

Clears the address genus Type terms.

Compliance:

mandatory - This method must be implemented.

matchSubscriptionId

void matchSubscriptionId(Id subscriptionId,
                       boolean match)

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

Parameters:

subscriptionId - a subscription Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - subscriptionId is null

Compliance:

mandatory - This method must be implemented.

clearSubscriptionIdTerms

void clearSubscriptionIdTerms()

Clears the subscription Id terms.

Compliance:

mandatory - This method must be implemented.

supportsSubscriptionQuery

boolean supportsSubscriptionQuery()

Tests if a subscription query is available.

Returns:

true if a subscription query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getSubscriptionQuery

SubscriptionQuery getSubscriptionQuery()

Gets the query for a dispatch.

Returns:

the subscription query

Throws:

UnimplementedException - supportsSubscriptionQuery() is false

Compliance:

optional - This method must be implemented if supportsSubscriptionQuery() is true.

matchAnySubscription

void matchAnySubscription(boolean match)

Matches dispatches with any subscription.

Parameters:

match - true to match dispatches with any subscription, false to match dispatches with no subscriptions

Compliance:

mandatory - This method must be implemented.

clearSubscriptionTerms

void clearSubscriptionTerms()

Clears the subscription terms.

Compliance:

mandatory - This method must be implemented.

matchPublisherId

void matchPublisherId(Id publisherId,
                    boolean match)

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

Parameters:

publisherId - a publisher Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - publisherId is null

Compliance:

mandatory - This method must be implemented.

clearPublisherIdTerms

void clearPublisherIdTerms()

Clears the publisher Id terms.

Compliance:

mandatory - This method must be implemented.

supportsPublisherQuery

boolean supportsPublisherQuery()

Tests if a PublisherQuery is available.

Returns:

true if a publisher query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getPublisherQuery

PublisherQuery getPublisherQuery()

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

Returns:

the publisher query

Throws:

UnimplementedException - supportsPublisherQuery() is false

Compliance:

optional - This method must be implemented if supportsPublisherQuery() is true.

clearPublisherTerms

void clearPublisherTerms()

Clears the publisher terms.

Compliance:

mandatory - This method must be implemented.

getDispatchQueryRecord

DispatchQueryRecord getDispatchQueryRecord(Type dispatchRecordType)
                                           throws OperationFailedException

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

Parameters:

dispatchRecordType - a dispatch record type

Returns:

the dispatch query record

Throws:

NullArgumentException - dispatchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(dispatchRecordType) is false

Compliance:

mandatory - This method must be implemented.