public interface PublisherQuery extends OsidCatalogQuery
This is the query for searching for publishers. Each method specifies
an AND
term while multiple invocations of the same method
produce a nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearAncestorPublisherIdTerms()
Clears the ancestor publisher
Id terms. |
void |
clearAncestorPublisherTerms()
Clears the ancestor publisher terms.
|
void |
clearDescendantPublisherIdTerms()
Clears the descendant publisher
Id terms. |
void |
clearDescendantPublisherTerms()
Clears the descendant publisher terms.
|
void |
clearDispatchIdTerms()
Clears the dispatch
Id terms. |
void |
clearDispatchTerms()
Clears the dispatch terms.
|
void |
clearSubscriptionIdTerms()
Clears the subscription
Id terms. |
void |
clearSubscriptionTerms()
Clears the subscription terms.
|
PublisherQuery |
getAncestorPublisherQuery()
Gets the query for a publisher.
|
PublisherQuery |
getDescendantPublisherQuery()
Gets the query for a publisher.
|
DispatchQuery |
getDispatchQuery()
Gets the query for a dispatch query.
|
PublisherQueryRecord |
getPublisherQueryRecord(Type publisherRecordType)
Gets the publisher query record corresponding to the given
Publisher record Type. |
SubscriptionQuery |
getSubscriptionQuery()
Gets the query for a publisher.
|
void |
matchAncestorPublisherId(Id publisherId,
boolean match)
Sets the publisher
Id for this query to match
publishers that have the specified publisher as an ancestor. |
void |
matchAnyAncestorPublisher(boolean match)
Matches publishers with any ancestor.
|
void |
matchAnyDescendantPublisher(boolean match)
Matches publishers with any descendant.
|
void |
matchAnyDispatch(boolean match)
Matches publishers with any dispatch.
|
void |
matchAnySubscription(boolean match)
Matches publishers with any subscription.
|
void |
matchDescendantPublisherId(Id publisherId,
boolean match)
Sets the publisher
Id for this query to match
publishers that have the specified publisher as a descendant. |
void |
matchDispatchId(Id dispatchId,
boolean match)
Sets the dispatch
Id for this query to match
subscriptions assigned to dispatches. |
void |
matchSubscriptionId(Id subscriptionId,
boolean match)
Sets the subscription
Id for this query to match
subscriptions assigned to publishers. |
boolean |
supportsAncestorPublisherQuery()
Tests if a
PublisherQuery is available. |
boolean |
supportsDescendantPublisherQuery()
Tests if a
PublisherQuery is available. |
boolean |
supportsDispatchQuery()
Tests if a
DispatchQuery is available. |
boolean |
supportsSubscriptionQuery()
Tests if a subscription query is available.
|
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
clearIdTerms, matchId
clearRecordTerms, matchAnyRecord, matchRecordType
getRecordTypes, hasRecordType
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType
clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery
void matchSubscriptionId(Id subscriptionId, boolean match)
Id
for this query to match
subscriptions assigned to publishers.subscriptionId
- a subscription Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- subscriptionId
is null
mandatory
- This method must be implemented. void clearSubscriptionIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsSubscriptionQuery()
true
if a subscription query is available,
false
otherwisemandatory
- This method must be implemented. SubscriptionQuery getSubscriptionQuery()
UnimplementedException
-
supportsSubscriptionQuery()
is false
optional
- This method must be implemented if
supportsSubscriptionQuery()
is true.
void matchAnySubscription(boolean match)
match
- true
to match publishers with any
subscription, false
to match publishers with no
subscriptionsmandatory
- This method must be implemented. void clearSubscriptionTerms()
mandatory
- This method must be implemented. void matchDispatchId(Id dispatchId, boolean match)
Id
for this query to match
subscriptions assigned to dispatches.dispatchId
- a dispatch Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- dispatchId
is
null
mandatory
- This method must be implemented. void clearDispatchIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsDispatchQuery()
DispatchQuery
is available. true
if a dispatch query is available,
false
otherwisemandatory
- This method must be implemented. DispatchQuery getDispatchQuery()
OR
term.UnimplementedException
- supportsDispatchQuery()
is false
optional
- This method must be implemented if
supportsDispatchQuery()
is true.
void matchAnyDispatch(boolean match)
match
- true
to match publishers with any
dispatch, false
to match publishers with no
dispatchesmandatory
- This method must be implemented. void clearDispatchTerms()
mandatory
- This method must be implemented. void matchAncestorPublisherId(Id publisherId, boolean match)
Id
for this query to match
publishers that have the specified publisher as an ancestor.publisherId
- a publisher Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- publisherId
is
null
mandatory
- This method must be implemented. void clearAncestorPublisherIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsAncestorPublisherQuery()
PublisherQuery
is available. true
if a publisher query is available,
false
otherwisemandatory
- This method must be implemented. PublisherQuery getAncestorPublisherQuery()
OR
term.UnimplementedException
-
supportsAncestorPublisherQuery()
is false
optional
- This method must be implemented if
supportsAncestorPublisherQuery()
is true.
void matchAnyAncestorPublisher(boolean match)
match
- true
to match publishers with any
ancestor, false
to match root publishersmandatory
- This method must be implemented. void clearAncestorPublisherTerms()
mandatory
- This method must be implemented. void matchDescendantPublisherId(Id publisherId, boolean match)
Id
for this query to match
publishers that have the specified publisher as a descendant.publisherId
- a publisher Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- publisherId
is
null
mandatory
- This method must be implemented. void clearDescendantPublisherIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsDescendantPublisherQuery()
PublisherQuery
is available. true
if a publisher query is available,
false
otherwisemandatory
- This method must be implemented. PublisherQuery getDescendantPublisherQuery()
OR
term.UnimplementedException
-
supportsDescendantPublisherQuery()
is false
optional
- This method must be implemented if
supportsDescendantPublisherQuery()
is true.
void matchAnyDescendantPublisher(boolean match)
match
- true
to match publishers with any
descendant, false
to match leaf publishersmandatory
- This method must be implemented. void clearDescendantPublisherTerms()
mandatory
- This method must be implemented. PublisherQueryRecord getPublisherQueryRecord(Type publisherRecordType) throws OperationFailedException
Publisher
record Type.
Multiple record
retrievals produce a nested boolean OR
term.publisherRecordType
- a publisher record typeNullArgumentException
- publisherRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(publisherRecordType)
is false
mandatory
- This method must be implemented.