Class AbstractSubscriptionQueryInspector
java.lang.Object
net.okapia.osid.jamocha.spi.AbstractOsidQueryInspector
net.okapia.osid.jamocha.spi.AbstractOsidIdentifiableQueryInspector
net.okapia.osid.jamocha.spi.AbstractOsidObjectQueryInspector
net.okapia.osid.jamocha.spi.AbstractTemporalOsidObjectQueryInspector
net.okapia.osid.jamocha.spi.AbstractOsidRelationshipQueryInspector
net.okapia.osid.jamocha.subscription.subscription.spi.AbstractSubscriptionQueryInspector
- All Implemented Interfaces:
Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidRelationshipQueryInspector, OsidTemporalQueryInspector, SubscriptionQueryInspector
- Direct Known Subclasses:
SubscriptionQueryUninspector
public abstract class AbstractSubscriptionQueryInspector
extends AbstractOsidRelationshipQueryInspector
implements SubscriptionQueryInspector
A query inspector template for subscriptions.
-
Nested Class Summary
Nested classes/interfaces inherited from class AbstractTemporalOsidObjectQueryInspector
AbstractTemporalOsidObjectQueryInspector.OsidTemporalQueryInspectorModifier and TypeClassDescriptionprotected classComposed OsidTemporalQueryInspector.Nested classes/interfaces inherited from class AbstractOsidObjectQueryInspector
AbstractOsidObjectQueryInspector.OsidBrowsableQueryInspectorModifier and TypeClassDescriptionprotected classComposed BrowsableQueryInspector. -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a newAbstractSubscriptionQueryInspector. -
Method Summary
Modifier and TypeMethodDescriptionprotected voidaddSubscriptionQueryInspectorRecord(SubscriptionQueryInspectorRecord subscriptionQueryInspectorRecord, Type subscriptionRecordType) Adds a record to this subscription query.IdTerm[]Gets the addressIdterms.Gets the address terms.IdTerm[]Gets the dispatchIdterms.Gets the dispatch terms.IdTerm[]Gets the publisherIdterms.Gets the publisher terms.IdTerm[]Gets the subscriberIdterms.Gets the subscriber terms.getSubscriptionQueryInspectorRecord(Type subscriptionRecordType) Gets the record corresponding to the given subscription query inspector recordType.Methods inherited from class AbstractOsidRelationshipQueryInspector
getEndReasonIdTerms, getEndReasonTermsModifier and TypeMethodDescriptionIdTerm[]Gets the end reaosn stateIdquery terms.Gets the end reason state query terms.Methods inherited from class AbstractTemporalOsidObjectQueryInspector
getDateTerms, getEffectiveTerms, getEndDateTerms, getStartDateTermsModifier and TypeMethodDescriptionGets the date query terms.Gets the effective query terms.Gets the end date query terms.Gets the start date query terms.Methods inherited from class AbstractOsidObjectQueryInspector
addRecordType, getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRecordTypes, getRecordTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTerms, hasRecordTypeModifier and TypeMethodDescriptionprotected voidaddRecordType(Type recordType) Adds a record type.IdTerm[]Gets the commentIdquery terms.Gets the comment query terms.IdTerm[]Gets the creditIdquery terms.Gets the credit query terms.Gets the description query terms.Gets the display name query terms.TypeTerm[]Gets the genus type query terms.IdTerm[]Gets the journal entryIdquery terms.Gets the journal entry query terms.TypeTerm[]Gets the parent genus type query terms.Gets the record types available in this object.TypeTerm[]Gets the record type query terms.IdTerm[]Gets the relationshipIdquery terms.IdTerm[]Gets the relationship peerIdquery terms.Gets the relationship query terms.IdTerm[]Gets the stateIdquery terms.Gets the state query terms.Gets the statistic query terms.IdTerm[]Gets the subjectIdquery terms.Gets the relevancy query terms.Gets the subject query terms.booleanhasRecordType(Type recordType) Tests if this object supports the given recordType.Methods inherited from class AbstractOsidIdentifiableQueryInspector
getIdTermsMethods inherited from class AbstractOsidQueryInspector
getAnyTerms, getKeywordTermsModifier and TypeMethodDescriptionGets the any query terms.Gets the keyword query terms.
-
Constructor Details
-
AbstractSubscriptionQueryInspector
public AbstractSubscriptionQueryInspector()Constructs a newAbstractSubscriptionQueryInspector.
-
-
Method Details
-
getDispatchIdTerms
Gets the dispatchIdterms.- Specified by:
getDispatchIdTermsin interfaceSubscriptionQueryInspector- Returns:
- the dispatch
Idterms
-
getDispatchTerms
Gets the dispatch terms.- Specified by:
getDispatchTermsin interfaceSubscriptionQueryInspector- Returns:
- the dispatch terms
-
getSubscriberIdTerms
Gets the subscriberIdterms.- Specified by:
getSubscriberIdTermsin interfaceSubscriptionQueryInspector- Returns:
- the resource
Idterms
-
getSubscriberTerms
Gets the subscriber terms.- Specified by:
getSubscriberTermsin interfaceSubscriptionQueryInspector- Returns:
- the resource terms
-
getAddressIdTerms
Gets the addressIdterms.- Specified by:
getAddressIdTermsin interfaceSubscriptionQueryInspector- Returns:
- the address
Idterms
-
getAddressTerms
Gets the address terms.- Specified by:
getAddressTermsin interfaceSubscriptionQueryInspector- Returns:
- the address terms
-
getPublisherIdTerms
Gets the publisherIdterms.- Specified by:
getPublisherIdTermsin interfaceSubscriptionQueryInspector- Returns:
- the publisher
Idterms
-
getPublisherTerms
Gets the publisher terms.- Specified by:
getPublisherTermsin interfaceSubscriptionQueryInspector- Returns:
- the publisher terms
-
getSubscriptionQueryInspectorRecord
@OSID public SubscriptionQueryInspectorRecord getSubscriptionQueryInspectorRecord(Type subscriptionRecordType) throws OperationFailedException Gets the record corresponding to the given subscription query inspector recordType.This method must be used to retrieve a subscription implementing the requested record.- Specified by:
getSubscriptionQueryInspectorRecordin interfaceSubscriptionQueryInspector- Parameters:
subscriptionRecordType- a subscription record type- Returns:
- the subscription query inspsector record
- Throws:
NullArgumentException-subscriptionRecordTypeisnullOperationFailedException- unable to complete requestUnsupportedException-hasRecordType(subscriptionRecordType)isfalse
-
addSubscriptionQueryInspectorRecord
protected void addSubscriptionQueryInspectorRecord(SubscriptionQueryInspectorRecord subscriptionQueryInspectorRecord, Type subscriptionRecordType) Adds a record to this subscription query.- Parameters:
subscriptionQueryInspectorRecord- subscription query inspector recordsubscriptionRecordType- subscription record type- Throws:
NullArgumentException-recordisnull
-