public interface AuthorizationQuery extends OsidRelationshipQuery
The query for authorizations.
Modifier and Type | Method and Description |
---|---|
void |
clearAgentIdTerms()
Clears the agent
Id query terms. |
void |
clearAgentTerms()
Clears the agent query terms.
|
void |
clearExplicitAuthorizationsTerms()
Clears the explicit authorization 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.
|
void |
clearRelatedAuthorizationIdTerms()
Clears the related authorization
Id query terms. |
void |
clearRelatedAuthorizationTerms()
Clears the related authorization query terms.
|
void |
clearResourceIdTerms()
Clears the resource
Id query terms. |
void |
clearResourceTerms()
Clears the resource query terms.
|
void |
clearTrustIdTerms()
Clears the trust
Id query terms. |
void |
clearVaultIdTerms()
Clears the vault
Id query terms. |
void |
clearVaultTerms()
Clears the vault query terms.
|
AgentQuery |
getAgentQuery(boolean match)
Gets the agent query.
|
AuthorizationQueryRecord |
getAuthorizationQueryRecord(Type authorizationRecordType)
Gets the authorization query record corresponding to the given
Authorization record Type. |
FunctionQuery |
getFunctionQuery(boolean match)
Gets the function query.
|
QualifierQuery |
getQualifierQuery(boolean match)
Gets the qualiier query.
|
AuthorizationQuery |
getRelatedAuthorizationQuery(boolean match)
Gets the authorization query.
|
ResourceQuery |
getResourceQuery(boolean match)
Gets the resource query.
|
VaultQuery |
getVaultQuery()
Gets the query for a vault.
|
void |
matchAgentId(Id agentId,
boolean match)
Matches the agent identified by the given
Id. |
void |
matchAnyAgent(boolean match)
Matches authorizations that have any agent.
|
void |
matchAnyResource(boolean match)
Matches authorizations that have any resource.
|
void |
matchAnyTrustId(boolean match)
Matches authorizations that have any trust defined.
|
void |
matchExplicitAuthorizations(boolean match)
Matches explciit authorizations.
|
void |
matchFunctionId(Id functionId,
boolean match)
Matches the function identified by the given
Id. |
void |
matchQualifierId(Id qualifierId,
boolean match)
Matches the qualifier identified by the given
Id. |
void |
matchRelatedAuthorizationId(Id id,
boolean match)
Adds an
Id to match explicit or implicitly related
authorizations depending on matchExplicitAuthorizations(). |
void |
matchResourceId(Id resourceId,
boolean match)
Matches the resource identified by the given
Id. |
void |
matchTrustId(Id trustId,
boolean match)
Matches the trust identified by the given
Id. |
void |
matchVaultId(Id vaultId,
boolean match)
Sets the vault
Id for this query. |
boolean |
supportsAgentQuery()
Tests if an
AgentQuery is available. |
boolean |
supportsFunctionQuery()
Tests if a
FunctionQuery is available. |
boolean |
supportsQualifierQuery()
Tests if a
QualifierQuery is available. |
boolean |
supportsRelatedAuthorizationQuery()
Tests if an
AuthorizationQuery is available. |
boolean |
supportsResourceQuery()
Tests if a
ResourceQuery is available. |
boolean |
supportsVaultQuery()
Tests if a
VaultQuery is available. |
clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQuery
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
clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate
void matchExplicitAuthorizations(boolean match)
match
- true
to match explicit authorizations,
false
to match implciit authorizationsmandatory
- This method must be implemented. void clearExplicitAuthorizationsTerms()
mandatory
- This method must be implemented. void matchRelatedAuthorizationId(Id id, boolean match)
Id
to match explicit or implicitly related
authorizations depending on matchExplicitAuthorizations().
Multiple Ids
can be added to perform a boolean
OR
among them.id
- Id
to matchmatch
- true
for a positive match, false
for a negative matchNullArgumentException
- id
is
null
mandatory
- This method must be implemented. void clearRelatedAuthorizationIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsRelatedAuthorizationQuery()
AuthorizationQuery
is available. true
if an authorization query is available,
false
otherwisemandatory
- This method must be implemented. AuthorizationQuery getRelatedAuthorizationQuery(boolean match)
match
- true
if a positive match, false
for a negative match AuthorizationQuery
UnimplementedException
-
supportsRelatedAuthorizationQuery()
is false
optional
- This method must be implemented if
supportsRelatedAuthorizationQuery()
is
true.
void clearRelatedAuthorizationTerms()
mandatory
- This method must be implemented. void matchResourceId(Id resourceId, boolean match)
Id.
resourceId
- the Id
of the Resource
match
- true
if a positive match, false
for a negative matchNullArgumentException
- resourceId
is
null
mandatory
- This method must be implemented. void clearResourceIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsResourceQuery()
ResourceQuery
is available. true
if a resource query is available,
false
otherwisemandatory
- This method must be implemented. ResourceQuery getResourceQuery(boolean match)
match
- true
if a positive match, false
for a negative match ResourceQuery
UnimplementedException
- supportsResourceQuery()
is false
optional
- This method must be implemented if
supportsResourceQuery()
is true.
void matchAnyResource(boolean match)
match
- true
to match authorizations with any
resource, false
to match authorizations with no
resourcemandatory
- This method must be implemented. void clearResourceTerms()
mandatory
- This method must be implemented. void matchTrustId(Id trustId, boolean match)
Id.
trustId
- the Id
of the Trust
match
- true
if a positive match, false
for a negative matchNullArgumentException
- trustId
is
null
mandatory
- This method must be implemented. void matchAnyTrustId(boolean match)
match
- true
to match authorizations with any
trust, false
to match authorizations with no
trustsmandatory
- This method must be implemented. void clearTrustIdTerms()
Id
query terms.mandatory
- This method must be implemented. void matchAgentId(Id agentId, boolean match)
Id.
agentId
- the Id of the Agent
match
- true
if a positive match, false
for a negative matchNullArgumentException
- agentId
is
null
mandatory
- This method must be implemented. void clearAgentIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsAgentQuery()
AgentQuery
is available. true
if an agent query is available,
false
otherwisemandatory
- This method must be implemented. AgentQuery getAgentQuery(boolean match)
match
- true
if a positive match, false
for a negative match AgentQuery
UnimplementedException
- supportsAgentQuery()
is false
optional
- This method must be implemented if
supportsAgentQuery()
is true.
void matchAnyAgent(boolean match)
match
- true
to match authorizations with any
agent, false
to match authorizations with no
agentmandatory
- This method must be implemented. void clearAgentTerms()
mandatory
- This method must be implemented. void matchFunctionId(Id functionId, boolean match)
Id.
functionId
- the Id of the Function
match
- true
if 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(boolean match)
match
- true
if a positive match, false
for a negative match FunctinQuery
UnimplementedException
- supportsFunctionQuery()
is false
optional
- This method must be implemented if
supportsFunctionQuery()
is true.
void clearFunctionTerms()
mandatory
- This method must be implemented. void matchQualifierId(Id qualifierId, boolean match)
Id.
qualifierId
- the Id of the Qualifier
match
- true
if 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(boolean match)
match
- true
if a positive match, false
for a negative match QualifierQuery
UnimplementedException
-
supportsQualifierQuery()
is false
optional
- This method must be implemented if
supportsQualifierQuery()
is true.
void clearQualifierTerms()
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. AuthorizationQueryRecord getAuthorizationQueryRecord(Type authorizationRecordType) throws OperationFailedException
Authorization
record Type.
Multiple retrievals
produce a nested OR
term.authorizationRecordType
- an authorization record typeNullArgumentException
- authorizationRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(authorizationRecordType)
is false
mandatory
- This method must be implemented.