org.osid.subscription

Interface PublisherQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidCatalogQueryInspector, OsidExtensibleQueryInspector, OsidFederateableQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidSourceableQueryInspector

public interface PublisherQueryInspector
extends OsidCatalogQueryInspector

This is the query inspector for examining for publisher queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getAncestorPublisherIdTerms() Gets the ancestor publisher Id terms.
PublisherQueryInspector[]	getAncestorPublisherTerms() Gets the ancestor publisher terms.
IdTerm[]	getDescendantPublisherIdTerms() Gets the descendant publisher Id terms.
PublisherQueryInspector[]	getDescendantPublisherTerms() Gets the descendant publisher terms.
IdTerm[]	getDispatchIdTerms() Gets the dispatch Id terms.
DispatchQueryInspector[]	getDispatchTerms() Gets the dispatch terms.
PublisherQueryInspectorRecord	getPublisherQueryInspectorRecord(Type publisherRecordType) Gets the publisher query inspector record corresponding to the given Publisher record Type.
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.OsidSourceableQueryInspector

getBrandingIdTerms, getBrandingTerms, getLicenseTerms, getProviderIdTerms, getProviderTerms

Method Detail

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.

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.

getAncestorPublisherIdTerms

IdTerm[] getAncestorPublisherIdTerms()

Gets the ancestor publisher Id terms.

Returns:

the ancestor publisher Id terms

Compliance:

mandatory - This method must be implemented.

getAncestorPublisherTerms

PublisherQueryInspector[] getAncestorPublisherTerms()

Gets the ancestor publisher terms.

Returns:

the ancestor publisher terms

Compliance:

mandatory - This method must be implemented.

getDescendantPublisherIdTerms

IdTerm[] getDescendantPublisherIdTerms()

Gets the descendant publisher Id terms.

Returns:

the descendant publisher Id terms

Compliance:

mandatory - This method must be implemented.

getDescendantPublisherTerms

PublisherQueryInspector[] getDescendantPublisherTerms()

Gets the descendant publisher terms.

Returns:

the descendant publisher terms

Compliance:

mandatory - This method must be implemented.

getPublisherQueryInspectorRecord

PublisherQueryInspectorRecord getPublisherQueryInspectorRecord(Type publisherRecordType)
                                                               throws OperationFailedException

Gets the publisher query inspector record corresponding to the given Publisher record Type.

Parameters:

publisherRecordType - a publisher record type

Returns:

the publisher query inspector record

Throws:

NullArgumentException - publisherRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(publisherRecordType) is false

Compliance:

mandatory - This method must be implemented.