public interface FunctionQuery extends OsidRuleQuery
This is the query for searching functions. 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 |
clearAuthorizationIdTerms()
Clears the authorization
Id query terms. |
void |
clearAuthorizationTerms()
Clears the authorization 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.
|
AuthorizationQuery |
getAuthorizationQuery()
Gets the query for an authorization.
|
FunctionQueryRecord |
getFunctionQueryRecord(Type functionRecordType)
Gets the function query record corresponding to the given
Function record Type. |
HierarchyQuery |
getQualifierHierarchyQuery()
Gets the query for a qualifier hierarchy.
|
VaultQuery |
getVaultQuery()
Gets the query for a vault.
|
void |
matchAnyAuthorization(boolean match)
Matches functions that have any authorization mapping.
|
void |
matchAnyQualifierHierarchy(boolean match)
Matches functions that have any qualifier hierarchy.
|
void |
matchAuthorizationId(Id authorizationId,
boolean match)
Sets the authorization
Id for this query. |
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 |
supportsAuthorizationQuery()
Tests if an
AuthorizationQuery is available. |
boolean |
supportsQualifierHierarchyQuery()
Tests if a
HierarchyQuery is available. |
boolean |
supportsVaultQuery()
Tests if a
VaultQuery is available. |
clearRuleIdTerms, clearRuleTerms, getRuleQuery, matchAnyRule, matchRuleId, supportsRuleQuery
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
clearActiveTerms, clearDisabledTerms, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational
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 matchAnyQualifierHierarchy(boolean match)
match
- true
to match functions with any
qualifier hierarchy, false
to match functions
with no qualifier hierarchymandatory
- This method must be implemented. 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 functions with any
authorization mapping, false
to match functions
with no authorization mappingmandatory
- This method must be implemented. void clearAuthorizationTerms()
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. FunctionQueryRecord getFunctionQueryRecord(Type functionRecordType) throws OperationFailedException
Function
record Type.
Multiple retrievals
produce a nested OR
term.functionRecordType
- a function record typeNullArgumentException
- functionRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(functionRecordType)
is false
mandatory
- This method must be implemented.