org.osid.subscription

Interface DispatchQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidGovernatorQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidOperableQueryInspector, OsidQueryInspector, OsidSourceableQueryInspector

public interface DispatchQueryInspector
extends OsidGovernatorQueryInspector

This is the query inspector for examining for dispatch queries.

Method Summary

Methods

Modifier and Type	Method and Description
TypeTerm[]	getAddressGenusTypeTerms() Gets the address genus Type terms.
DispatchQueryInspectorRecord	getDispatchQueryInspectorRecord(Type dispatchRecordType) Gets the dispatch query inspector record corresponding to the given Dispatch record Type.
IdTerm[]	getPublisherIdTerms() Gets the publisher Id terms.
PublisherQueryInspector[]	getPublisherTerms() Gets the publisher terms.
IdTerm[]	getSubscriptionIdTerms() Gets the subscription Id terms.
SubscriptionQueryInspector[]	getSubscriptionTerms() Gets the subscription terms.

Methods inherited from interface org.osid.OsidObjectQueryInspector

getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTerms

Methods inherited from interface org.osid.OsidIdentifiableQueryInspector

getIdTerms

Methods inherited from interface org.osid.OsidExtensibleQueryInspector

getRecordTypeTerms

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQueryInspector

getAnyTerms, getKeywordTerms

Methods inherited from interface org.osid.OsidOperableQueryInspector

getActiveTerms, getDisabledTerms, getEnabledTerms, getOperationalTerms

Methods inherited from interface org.osid.OsidSourceableQueryInspector

getBrandingIdTerms, getBrandingTerms, getLicenseTerms, getProviderIdTerms, getProviderTerms

Method Detail

getAddressGenusTypeTerms

TypeTerm[] getAddressGenusTypeTerms()

Gets the address genus Type terms.

Returns:

the address genus Type terms

Compliance:

mandatory - This method must be implemented.

getSubscriptionIdTerms

IdTerm[] getSubscriptionIdTerms()

Gets the subscription Id terms.

Returns:

the subscription Id terms

Compliance:

mandatory - This method must be implemented.

getSubscriptionTerms

SubscriptionQueryInspector[] getSubscriptionTerms()

Gets the subscription terms.

Returns:

the subscription terms

Compliance:

mandatory - This method must be implemented.

getPublisherIdTerms

IdTerm[] getPublisherIdTerms()

Gets the publisher Id terms.

Returns:

the publisher Id terms

Compliance:

mandatory - This method must be implemented.

getPublisherTerms

PublisherQueryInspector[] getPublisherTerms()

Gets the publisher terms.

Returns:

the publisher terms

Compliance:

mandatory - This method must be implemented.

getDispatchQueryInspectorRecord

DispatchQueryInspectorRecord getDispatchQueryInspectorRecord(Type dispatchRecordType)
                                                             throws OperationFailedException

Gets the dispatch query inspector record corresponding to the given Dispatch record Type.

Parameters:

dispatchRecordType - a dispatch record type

Returns:

the dispatch query inspector record

Throws:

NullArgumentException - dispatchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(dispatchRecordType) is false

Compliance:

mandatory - This method must be implemented.