public interface DepotQuery extends OsidCatalogQuery
This is the query for searching depots. Each method specifies an
AND
term while multiple invocations of the same method produce a
nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearAncestorDepotIdTerms()
Clears the ancestor depot
Id query terms. |
void |
clearAncestorDepotTerms()
Clears the ancestor depot query terms.
|
void |
clearDescendantDepotIdTerms()
Clears the descendant depot
Id query terms. |
void |
clearDescendantDepotTerms()
Clears the descendant depot query terms.
|
void |
clearPackageIdTerms()
Clears the package
Id query terms. |
void |
clearPackageTerms()
Clears the package query terms.
|
DepotQuery |
getAncestorDepotQuery()
Gets the query for a Depot.
|
DepotQueryRecord |
getDepotQueryRecord(Type depotRecordType)
Gets the depot query record corresponding to the given
Depot
record Type. |
DepotQuery |
getDescendantDepotQuery()
Gets the query for a Depot.
|
PackageQuery |
getPackageQuery()
Gets the query for a package.
|
void |
matchAncestorDepotId(Id depotId,
boolean match)
Sets the depot
Id for this query to match depots that
have the specified depot as an ancestor. |
void |
matchAnyAncestorDepot(boolean match)
Matches depots with any ancestor.
|
void |
matchAnyDescendantDepot(boolean match)
Matches depots with any descendant.
|
void |
matchAnyPackage(boolean match)
Matches depots that have any package.
|
void |
matchDescendantDepotId(Id depotId,
boolean match)
Sets the depot
Id for this query to match depots that
have the specified depot as a descendant. |
void |
matchPackageId(Id packageId,
boolean match)
Sets the package
Id for this query. |
boolean |
supportsAncestorDepotQuery()
Tests if a
DepotQuery is available. |
boolean |
supportsDescendantDepotQuery()
Tests if a
DepotQuery is available. |
boolean |
supportsPackageQuery()
Tests if a
PackageQuery 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 matchPackageId(Id packageId, boolean match)
Id
for this query.packageId
- a package Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- packageId
is
null
mandatory
- This method must be implemented. void clearPackageIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsPackageQuery()
PackageQuery
is available. true
if a package query is available,
false
otherwisemandatory
- This method must be implemented. PackageQuery getPackageQuery()
OR
term.UnimplementedException
- supportsPackageQuery()
is false
optional
- This method must be implemented if
supportsPackageQuery()
is true.
void matchAnyPackage(boolean match)
match
- true
to match depots with any packages,
false
to match depots with no packagesmandatory
- This method must be implemented. void clearPackageTerms()
mandatory
- This method must be implemented. void matchAncestorDepotId(Id depotId, boolean match)
Id
for this query to match depots that
have the specified depot as an ancestor.depotId
- a depot Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- depotId
is
null
mandatory
- This method must be implemented. void clearAncestorDepotIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsAncestorDepotQuery()
DepotQuery
is available. true
if a depot query is available,
false
otherwisemandatory
- This method must be implemented. DepotQuery getAncestorDepotQuery()
OR
term.UnimplementedException
-
supportsAncestorDepotQuery()
is false
optional
- This method must be implemented if
supportsAncestorDepotQuery()
is true.
void matchAnyAncestorDepot(boolean match)
match
- true
to match depots with any ancestor,
false
to match root depotsmandatory
- This method must be implemented. void clearAncestorDepotTerms()
mandatory
- This method must be implemented. void matchDescendantDepotId(Id depotId, boolean match)
Id
for this query to match depots that
have the specified depot as a descendant.depotId
- a depot Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- depotId
is
null
mandatory
- This method must be implemented. void clearDescendantDepotIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsDescendantDepotQuery()
DepotQuery
is available. true
if a depot query is available,
false
otherwisemandatory
- This method must be implemented. DepotQuery getDescendantDepotQuery()
OR
term.UnimplementedException
-
supportsDescendantDepotQuery()
is false
optional
- This method must be implemented if
supportsDescendantDepotQuery()
is true.
void matchAnyDescendantDepot(boolean match)
match
- true
to match depots with any descendant,
false
to match leaf depotsmandatory
- This method must be implemented. void clearDescendantDepotTerms()
mandatory
- This method must be implemented. DepotQueryRecord getDepotQueryRecord(Type depotRecordType) throws OperationFailedException
Depot
record Type.
Multiple record retrievals produce
a nested OR
term.depotRecordType
- a depot record typeNullArgumentException
- depotRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(depotRecordType)
is false
mandatory
- This method must be implemented.