public interface CatalogueQuery extends OsidCatalogQuery
This is the query for searching for catalogues. Each method specifies
an AND
term while multiple invocations of the same method
produce a nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearAncestorCatalogueIdTerms()
Clears all ancestor catalogue
Id terms. |
void |
clearAncestorCatalogueTerms()
Clears all ancestor catalogue terms.
|
void |
clearCanonicalUnitIdTerms()
Clears all canonical unit
Id terms. |
void |
clearCanonicalUnitTerms()
Clears all canonical unit terms.
|
void |
clearDescendantCatalogueIdTerms()
Clears all descendant catalogue
Id terms. |
void |
clearDescendantCatalogueTerms()
Clears all descendant catalogue terms.
|
void |
clearOfferingIdTerms()
Clears all offering
Id terms. |
void |
clearOfferingTerms()
Clears all offering terms.
|
void |
clearParticipantIdTerms()
Clears all participant
Id terms. |
void |
clearParticipantTerms()
Clears all participant terms.
|
void |
clearResultIdTerms()
Clears all result
Id terms. |
void |
clearResultTerms()
Clears all result terms.
|
CatalogueQuery |
getAncestorCatalogueQuery()
Gets the query for a catalogue.
|
CanonicalUnitQuery |
getCanonicalUnitQuery()
Gets the query for a catalogue.
|
CatalogueQueryRecord |
getCatalogueQueryRecord(Type catalogueRecordType)
Gets the record query corresponding to the given
Catalogue
record Type. |
CatalogueQuery |
getDescendantCatalogueQuery()
Gets the query for a catalogue.
|
OfferingQuery |
getOfferingQuery()
Gets the query for an offering.
|
ParticipantQuery |
getParticipantQuery()
Gets the query for a participant.
|
ResultQuery |
getResultQuery()
Gets the query for an result.
|
void |
matchAncestorCatalogueId(Id catalogueId,
boolean match)
Sets the catalogue
Id for this query to match
catalogues that have the specified catalogue as an ancestor. |
void |
matchAnyAncestorCatalogue(boolean match)
Matches catalogues with any ancestor.
|
void |
matchAnyCanonicalUnit(boolean match)
Matches catalogues with any canonical unit.
|
void |
matchAnyDescendantCatalogue(boolean match)
Matches catalogues with any descendant.
|
void |
matchAnyOffering(boolean match)
Matches catalogues with any offering.
|
void |
matchAnyParticipant(boolean match)
Matches catalogues with any participant.
|
void |
matchAnyResult(boolean match)
Matches catalogues with any result.
|
void |
matchCanonicalUnitId(Id canonicalUnitId,
boolean match)
Sets the canonical unit
Id for this query to match
canonical units assigned to catalogues. |
void |
matchDescendantCatalogueId(Id catalogueId,
boolean match)
Sets the catalogue
Id for this query to match
catalogues that have the specified catalogue as a descendant. |
void |
matchOfferingId(Id offeringId,
boolean match)
Sets the offering
Id for this query to match offerings
assigned to catalogues. |
void |
matchParticipantId(Id participantId,
boolean match)
Sets the participant
Id for this query to match
participants assigned to catalogues. |
void |
matchResultId(Id resultId,
boolean match)
Sets the result
Id for this query to match results. |
boolean |
supportsAncestorCatalogueQuery()
Tests if a
CatalogueQuery is available. |
boolean |
supportsCanonicalUnitQuery()
Tests if a canonical unit query is available.
|
boolean |
supportsDescendantCatalogueQuery()
Tests if a
CatalogueQuery is available. |
boolean |
supportsOfferingQuery()
Tests if an offering query is available.
|
boolean |
supportsParticipantQuery()
Tests if a participant query is available.
|
boolean |
supportsResultQuery()
Tests if an result 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 matchCanonicalUnitId(Id canonicalUnitId, boolean match)
Id
for this query to match
canonical units assigned to catalogues.canonicalUnitId
- a canonical unit Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- canonicalUnitId
is null
mandatory
- This method must be implemented. void clearCanonicalUnitIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsCanonicalUnitQuery()
true
if a canonical unit query is available,
false
otherwisemandatory
- This method must be implemented. CanonicalUnitQuery getCanonicalUnitQuery()
UnimplementedException
-
supportsCanonicalUnitQuery()
is false
optional
- This method must be implemented if
supportsCanonicalUnitQuery()
is true.
void matchAnyCanonicalUnit(boolean match)
match
- true
to match catalogues with any
canonical unit, false
to match catalogues with
no canonical unitsmandatory
- This method must be implemented. void clearCanonicalUnitTerms()
mandatory
- This method must be implemented. void matchOfferingId(Id offeringId, boolean match)
Id
for this query to match offerings
assigned to catalogues.offeringId
- an offering Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- offeringId
is
null
mandatory
- This method must be implemented. void clearOfferingIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsOfferingQuery()
true
if an offering query is available,
false
otherwisemandatory
- This method must be implemented. OfferingQuery getOfferingQuery()
UnimplementedException
- supportsOfferingQuery()
is false
optional
- This method must be implemented if
supportsOfferingQuery()
is true.
void matchAnyOffering(boolean match)
match
- true
to match catalogues with any
offering, false
to match catalogues with no
offeringsmandatory
- This method must be implemented. void clearOfferingTerms()
mandatory
- This method must be implemented. void matchParticipantId(Id participantId, boolean match)
Id
for this query to match
participants assigned to catalogues.participantId
- a participant Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- participantId
is
null
mandatory
- This method must be implemented. void clearParticipantIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsParticipantQuery()
true
if a participant query is available,
false
otherwisemandatory
- This method must be implemented. ParticipantQuery getParticipantQuery()
UnimplementedException
-
supportsParticipantQuery()
is false
optional
- This method must be implemented if
supportsParticipantQuery()
is true.
void matchAnyParticipant(boolean match)
match
- true
to match catalogues with any
participant, false
to match catalogues with no
participantsmandatory
- This method must be implemented. void clearParticipantTerms()
mandatory
- This method must be implemented. void matchResultId(Id resultId, boolean match)
Id
for this query to match results.resultId
- an result Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- resultId
is
null
mandatory
- This method must be implemented. void clearResultIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsResultQuery()
true
if an result query is available,
false
otherwisemandatory
- This method must be implemented. ResultQuery getResultQuery()
UnimplementedException
- supportsResultQuery()
is false
optional
- This method must be implemented if
supportsResultQuery()
is true.
void matchAnyResult(boolean match)
match
- true
to match catalogues with any result,
false
to match catalogues with no resultsmandatory
- This method must be implemented. void clearResultTerms()
mandatory
- This method must be implemented. void matchAncestorCatalogueId(Id catalogueId, boolean match)
Id
for this query to match
catalogues that have the specified catalogue as an ancestor.catalogueId
- a catalogue Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- catalogueId
is
null
mandatory
- This method must be implemented. void clearAncestorCatalogueIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsAncestorCatalogueQuery()
CatalogueQuery
is available. true
if a catalogue query is available,
false
otherwisemandatory
- This method must be implemented. CatalogueQuery getAncestorCatalogueQuery()
OR
term.UnimplementedException
-
supportsAncestorCatalogueQuery()
is false
optional
- This method must be implemented if
supportsAncestorCatalogueQuery()
is true.
void matchAnyAncestorCatalogue(boolean match)
match
- true
to match catalogues with any
ancestor, false
to match root cataloguesmandatory
- This method must be implemented. void clearAncestorCatalogueTerms()
mandatory
- This method must be implemented. void matchDescendantCatalogueId(Id catalogueId, boolean match)
Id
for this query to match
catalogues that have the specified catalogue as a descendant.catalogueId
- a catalogue Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- catalogueId
is
null
mandatory
- This method must be implemented. void clearDescendantCatalogueIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsDescendantCatalogueQuery()
CatalogueQuery
is available. true
if a catalogue query is available,
false
otherwisemandatory
- This method must be implemented. CatalogueQuery getDescendantCatalogueQuery()
OR
term.UnimplementedException
-
supportsDescendantCatalogueQuery()
is false
optional
- This method must be implemented if
supportsDescendantCatalogueQuery()
is true.
void matchAnyDescendantCatalogue(boolean match)
match
- true
to match catalogues with any
descendant, false
to match leaf cataloguesmandatory
- This method must be implemented. void clearDescendantCatalogueTerms()
mandatory
- This method must be implemented. CatalogueQueryRecord getCatalogueQueryRecord(Type catalogueRecordType) throws OperationFailedException
Catalogue
record Type.
Multiple record retrievals produce
a nested boolean OR
term.catalogueRecordType
- a catalogue record typeNullArgumentException
- catalogueRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(catalogueRecordType)
is false
mandatory
- This method must be implemented.