public interface QualifierQuery extends OsidObjectQuery, OsidFederateableQuery
This is the query for searching qualifiers. Each method match request
produces an AND
term while multiple invocations of a method
produces a nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearAncestorQualifierIdTerms()
Clears the ancestor qualifier
Id query terms. |
void |
clearAncestorQualifierTerms()
Clears the ancestor qualifier query terms.
|
void |
clearAuthorizationIdTerms()
Clears the authorization
Id query terms. |
void |
clearAuthorizationTerms()
Clears the authorization query terms.
|
void |
clearDescendantQualifierIdTerms()
Clears the descendant qualifier
Id query terms. |
void |
clearDescendantQualifierTerms()
Clears the descendant qualifier query terms.
|
void |
clearQualifierHierarchyIdTerms()
Clears the qualifier hierarchy
Id query terms. |
void |
clearQualifierHierarchyTerms()
Clears the qualifier hierarchy query terms.
|
void |
clearVaultIdTerms()
Clears the vault
Id query terms. |
void |
clearVaultTerms()
Clears the vault query terms.
|
QualifierQuery |
getAncestorQualifierQuery()
Gets the query for a qualifier.
|
AuthorizationQuery |
getAuthorizationQuery()
Gets the query for an authorization.
|
QualifierQuery |
getDescendantQualifierQuery()
Gets the query for a qualifier.
|
HierarchyQuery |
getQualifierHierarchyQuery()
Gets the query for a qualifier hierarchy.
|
QualifierQueryRecord |
getQualifierQueryRecord(Type qualifierRecordType)
Gets the qualfiier query record corresponding to the given
Qualifier record Type. |
VaultQuery |
getVaultQuery()
Gets the query for a vault.
|
void |
matchAncestorQualifierId(Id qualifierId,
boolean match)
Sets the qualifier
Id for this query to match
qualifiers that have the specified qualifier as an ancestor. |
void |
matchAnyAncestorQualifier(boolean match)
Matches qualifiers that have any ancestor.
|
void |
matchAnyAuthorization(boolean match)
Matches qualifiers that have any authorization mapping.
|
void |
matchAnyDescendantQualifier(boolean match)
Matches qualifiers that have any ancestor.
|
void |
matchAuthorizationId(Id authorizationId,
boolean match)
Sets the authorization
Id for this query. |
void |
matchDescendantQualifierId(Id qualifierId,
boolean match)
Sets the qualifier
Id for this query to match
qualifiers that have the specified qualifier as a descendant. |
void |
matchQualifierHierarchyId(Id qualifierHierarchyId,
boolean match)
Sets the qualifier hierarchy
Id for this query. |
void |
matchVaultId(Id vaultId,
boolean match)
Sets the vault
Id for this query. |
boolean |
supportsAncestorQualifierQuery()
Tests if a
QualifierQuery is available. |
boolean |
supportsAuthorizationQuery()
Tests if an
AuthorizationQuery is available. |
boolean |
supportsDescendantQualifierQuery()
Tests if a
QualifierQuery is available. |
boolean |
supportsQualifierHierarchyQuery()
Tests if a
HierarchyQuery is available. |
boolean |
supportsVaultQuery()
Tests if a
VaultQuery 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
void matchQualifierHierarchyId(Id qualifierHierarchyId, boolean match)
Id
for this query.qualifierHierarchyId
- a hierarchy Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- qualifierHierarchyId
is null
mandatory
- This method must be implemented. void clearQualifierHierarchyIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsQualifierHierarchyQuery()
HierarchyQuery
is available. true
if a qualifier hierarchy query is
available, false
otherwisemandatory
- This method must be implemented. HierarchyQuery getQualifierHierarchyQuery()
OR
term.UnimplementedException
-
supportsQualifierHierarchyQuery()
is false
optional
- This method must be implemented if
supportsQualifierHierarchyQuery()
is true.
void clearQualifierHierarchyTerms()
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 qualifiers with any
authorization mapping, false
to match
qualifiers with no authorization mappingmandatory
- This method must be implemented. void clearAuthorizationTerms()
mandatory
- This method must be implemented. void matchAncestorQualifierId(Id qualifierId, boolean match)
Id
for this query to match
qualifiers that have the specified qualifier as an ancestor.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 clearAncestorQualifierIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsAncestorQualifierQuery()
QualifierQuery
is available. true
if a qualifier query is available,
false
otherwisemandatory
- This method must be implemented. QualifierQuery getAncestorQualifierQuery()
OR
term.UnimplementedException
-
supportsAncestorQualifierQuery()
is false
optional
- This method must be implemented if
supportsAncestorQualifierQuery()
is true.
void matchAnyAncestorQualifier(boolean match)
match
- true
to match qualifiers with any
ancestor, false
to match root qualifiersmandatory
- This method must be implemented. void clearAncestorQualifierTerms()
mandatory
- This method must be implemented. void matchDescendantQualifierId(Id qualifierId, boolean match)
Id
for this query to match
qualifiers that have the specified qualifier as a descendant.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 clearDescendantQualifierIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsDescendantQualifierQuery()
QualifierQuery
is available. true
if a qualifier query is available,
false
otherwisemandatory
- This method must be implemented. QualifierQuery getDescendantQualifierQuery()
OR
term.UnimplementedException
-
supportsDescendantQualifierQuery()
is false
optional
- This method must be implemented if
supportsDescendantQualifierQuery()
is true.
void matchAnyDescendantQualifier(boolean match)
match
- true
to match qualifiers with any
ancestor, false
to match leaf qualifiersmandatory
- This method must be implemented. void clearDescendantQualifierTerms()
mandatory
- This method must be implemented. void matchVaultId(Id vaultId, boolean match)
Id
for this query.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 clearVaultIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsVaultQuery()
VaultQuery
is available. true
if a vault query is available,
false
otherwisemandatory
- This method must be implemented. VaultQuery getVaultQuery()
OR
term.UnimplementedException
- supportsVaultQuery()
is false
optional
- This method must be implemented if
supportsVaultQuery()
is true.
void clearVaultTerms()
mandatory
- This method must be implemented. QualifierQueryRecord getQualifierQueryRecord(Type qualifierRecordType) throws OperationFailedException
Qualifier
record Type.
Multiple retrievals
produce a nested OR
term.qualifierRecordType
- a qualifier record typeNullArgumentException
- qualifierRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(qualifierRecordType)
is false
mandatory
- This method must be implemented.