org.osid.subscription

Interface SubscriptionQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidRelationshipQueryInspector, OsidTemporalQueryInspector

public interface SubscriptionQueryInspector
extends OsidRelationshipQueryInspector

The query inspector for examining subscription queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getAddressIdTerms() Gets the address Id terms.
AddressQueryInspector[]	getAddressTerms() Gets the address terms.
IdTerm[]	getDispatchIdTerms() Gets the dispatch Id terms.
DispatchQueryInspector[]	getDispatchTerms() Gets the dispatch terms.
IdTerm[]	getPublisherIdTerms() Gets the publisher Id terms.
PublisherQueryInspector[]	getPublisherTerms() Gets the publisher terms.
IdTerm[]	getSubscriberIdTerms() Gets the subscriber Id terms.
ResourceQueryInspector[]	getSubscriberTerms() Gets the subscriber terms.
SubscriptionQueryInspectorRecord	getSubscriptionQueryInspectorRecord(Type subscriptionRecordType) Gets the subscription query inspector record corresponding to the given Subscription record Type.

Methods inherited from interface org.osid.OsidRelationshipQueryInspector

getEndReasonIdTerms, getEndReasonTerms

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.OsidTemporalQueryInspector

getDateTerms, getEffectiveTerms, getEndDateTerms, getStartDateTerms

Method Detail

getDispatchIdTerms

IdTerm[] getDispatchIdTerms()

Gets the dispatch Id terms.

Returns:

the dispatch Id terms

Compliance:

mandatory - This method must be implemented.

getDispatchTerms

DispatchQueryInspector[] getDispatchTerms()

Gets the dispatch terms.

Returns:

the dispatch terms

Compliance:

mandatory - This method must be implemented.

getSubscriberIdTerms

IdTerm[] getSubscriberIdTerms()

Gets the subscriber Id terms.

Returns:

the resource Id terms

Compliance:

mandatory - This method must be implemented.

getSubscriberTerms

ResourceQueryInspector[] getSubscriberTerms()

Gets the subscriber terms.

Returns:

the resource terms

Compliance:

mandatory - This method must be implemented.

getAddressIdTerms

IdTerm[] getAddressIdTerms()

Gets the address Id terms.

Returns:

the address Id terms

Compliance:

mandatory - This method must be implemented.

getAddressTerms

AddressQueryInspector[] getAddressTerms()

Gets the address terms.

Returns:

the address 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.

getSubscriptionQueryInspectorRecord

SubscriptionQueryInspectorRecord getSubscriptionQueryInspectorRecord(Type subscriptionRecordType)
                                                                     throws OperationFailedException

Gets the subscription query inspector record corresponding to the given Subscription record Type.

Parameters:

subscriptionRecordType - a subscription record type

Returns:

the subscription query inspector record

Throws:

NullArgumentException - subscriptionRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(subscriptionRecordType) is false

Compliance:

mandatory - This method must be implemented.