public interface VaultQuery extends OsidCatalogQuery
This is the query for searching vaults. Each method specifies an
AND
term while multiple invocations of the same method produce a
nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearAncestorVaultIdTerms()
Clears the ancestor vault
Id query terms. |
void |
clearAncestorVaultTerms()
Clears the ancestor vault query terms.
|
void |
clearAuthorizationIdTerms()
Clears the authorization
Id query terms. |
void |
clearAuthorizationTerms()
Clears the authorization query terms.
|
void |
clearDescendantVaultIdTerms()
Clears the descendant vault
Id query terms. |
void |
clearDescendantVaultTerms()
Clears the descendant vault query terms.
|
void |
clearFunctionIdTerms()
Clears the function
Id query terms. |
void |
clearFunctionTerms()
Clears the function query terms.
|
void |
clearQualifierIdTerms()
Clears the qualifier
Id query terms. |
void |
clearQualifierTerms()
Clears the qualifier query terms.
|
VaultQuery |
getAncestorVaultQuery()
Gets the query for a vault.
|
AuthorizationQuery |
getAuthorizationQuery()
Gets the query for an authorization.
|
VaultQuery |
getDescendantVaultQuery()
Gets the query for a vault.
|
FunctionQuery |
getFunctionQuery()
Gets the query for a function.
|
QualifierQuery |
getQualifierQuery()
Gets the query for a qualifier.
|
VaultQueryRecord |
getVaultQueryRecord(Type vaultRecordType)
Gets the vault query record corresponding to the given
Vault
record Type. |
void |
matchAncestorVaultId(Id vaultId,
boolean match)
Sets the vault
Id for this query to match vaults that
have the specified vault as an ancestor. |
void |
matchAnyAncestorVault(boolean match)
Matches vaults that have any ancestor.
|
void |
matchAnyAuthorization(boolean match)
Matches vaults that have any authorization.
|
void |
matchAnyDescendantVault(boolean match)
Matches vaults that have any descendant.
|
void |
matchAnyFunction(boolean match)
Matches vaults that have any function.
|
void |
matchAnyQualifier(boolean match)
Matches vaults that have any qualifier.
|
void |
matchAuthorizationId(Id authorizationId,
boolean match)
Sets the authorization
Id for this query. |
void |
matchDescendantVaultId(Id vaultId,
boolean match)
Sets the vault
Id for this query to match vaults that
have the specified vault as a descendant. |
void |
matchFunctionId(Id functionId,
boolean match)
Sets the function
Id for this query. |
void |
matchQualifierId(Id qualifierId,
boolean match)
Sets the qualifier
Id for this query. |
boolean |
supportsAncestorVaultQuery()
Tests if a
VaultQuery is available. |
boolean |
supportsAuthorizationQuery()
Tests if an
AuthorizationQuery is available. |
boolean |
supportsDescendantVaultQuery()
Tests if a
VaultQuery is available. |
boolean |
supportsFunctionQuery()
Tests if a
FunctionQuery is available. |
boolean |
supportsQualifierQuery()
Tests if a
QualifierQuery 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 matchFunctionId(Id functionId, boolean match)
Id
for this query.functionId
- a function Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- functionId
is
null
mandatory
- This method must be implemented. void clearFunctionIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsFunctionQuery()
FunctionQuery
is available. true
if a function query is available,
false
otherwisemandatory
- This method must be implemented. FunctionQuery getFunctionQuery()
OR
term.UnimplementedException
- supportsFunctionQuery()
is false
optional
- This method must be implemented if
supportsFunctionQuery()
is true.
void matchAnyFunction(boolean match)
match
- true
to match vaults with any function
mapping, false
to match vaults with no function
mappingmandatory
- This method must be implemented. void clearFunctionTerms()
mandatory
- This method must be implemented. void matchQualifierId(Id qualifierId, boolean match)
Id
for this query.qualifierId
- a qualifier Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- qualifierId
is
null
mandatory
- This method must be implemented. void clearQualifierIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsQualifierQuery()
QualifierQuery
is available. true
if a qualifier query is available,
false
otherwisemandatory
- This method must be implemented. QualifierQuery getQualifierQuery()
OR
term.UnimplementedException
-
supportsQualifierQuery()
is false
optional
- This method must be implemented if
supportsQualifierQuery()
is true.
void matchAnyQualifier(boolean match)
match
- true
to match vaults with any qualifier
mapping, false
to match vaults with no
qualifier mappingmandatory
- This method must be implemented. void clearQualifierTerms()
mandatory
- This method must be implemented. void matchAuthorizationId(Id authorizationId, boolean match)
Id
for this query.authorizationId
- an authorization Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- authorizationId
is null
mandatory
- This method must be implemented. void clearAuthorizationIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsAuthorizationQuery()
AuthorizationQuery
is available. true
if an authorization query is available,
false
otherwisemandatory
- This method must be implemented. AuthorizationQuery getAuthorizationQuery()
OR
term.UnimplementedException
-
supportsAuthorizationQuery()
is false
optional
- This method must be implemented if
supportsAuthorizationQuery()
is true.
void matchAnyAuthorization(boolean match)
match
- true
to match vaults with any
authorization mapping, false
to match vaults
with no authorization mappingmandatory
- This method must be implemented. void clearAuthorizationTerms()
mandatory
- This method must be implemented. void matchAncestorVaultId(Id vaultId, boolean match)
Id
for this query to match vaults that
have the specified vault as an ancestor.vaultId
- a vault Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- vaultId
is
null
mandatory
- This method must be implemented. void clearAncestorVaultIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsAncestorVaultQuery()
VaultQuery
is available. true
if a vault query is available,
false
otherwisemandatory
- This method must be implemented. VaultQuery getAncestorVaultQuery()
OR
term.UnimplementedException
-
supportsAncestorVaultQuery()
is false
optional
- This method must be implemented if
supportsAncestorVaultQuery()
is true.
void matchAnyAncestorVault(boolean match)
match
- true
to match vaults with any ancestor,
false
to match root vaultsmandatory
- This method must be implemented. void clearAncestorVaultTerms()
mandatory
- This method must be implemented. void matchDescendantVaultId(Id vaultId, boolean match)
Id
for this query to match vaults that
have the specified vault as a descendant.vaultId
- a vault Id
match
- true
for a positive match, false
for negative matchNullArgumentException
- vaultId
is
null
mandatory
- This method must be implemented. void clearDescendantVaultIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsDescendantVaultQuery()
VaultQuery
is available. true
if a vault query is available,
false
otherwisemandatory
- This method must be implemented. VaultQuery getDescendantVaultQuery()
OR
term.UnimplementedException
-
supportsDescendantVaultQuery()
is false
optional
- This method must be implemented if
supportsDescendantVaultQuery()
is true.
void matchAnyDescendantVault(boolean match)
match
- true
to match vaults with any Ddscendant,
false
to match leaf vaultsmandatory
- This method must be implemented. void clearDescendantVaultTerms()
mandatory
- This method must be implemented. VaultQueryRecord getVaultQueryRecord(Type vaultRecordType) throws OperationFailedException
Vault
record Type.
Multiple record retrievals produce
a nested OR
term.vaultRecordType
- a vault record typeNullArgumentException
- vaultRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(vaultRecordType)
is false
mandatory
- This method must be implemented.