public interface AuthorizationEnablerQuery extends OsidEnablerQuery
This is the query for searching authorization enablers. Each method
match specifies an AND
term while multiple invocations of
the same method produce a nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearRuledAuthorizationIdTerms()
Clears the authorization
Id query terms. |
void |
clearRuledAuthorizationTerms()
Clears the authorization query terms.
|
void |
clearVaultIdTerms()
Clears the vault
Id query terms. |
void |
clearVaultTerms()
Clears the vault query terms.
|
AuthorizationEnablerQueryRecord |
getAuthorizationEnablerQueryRecord(Type authorizationEnablerRecordType)
Gets the authorization enabler query record corresponding to the given
AuthorizationEnabler record Type. |
AuthorizationQuery |
getRuledAuthorizationQuery()
Gets the query for an authorization.
|
VaultQuery |
getVaultQuery()
Gets the query for a vault.
|
void |
matchAnyRuledAuthorization(boolean match)
Matches enablers mapped to any authorization.
|
void |
matchRuledAuthorizationId(Id authorizationId,
boolean match)
Matches enablers mapped to an authorization.
|
void |
matchVaultId(Id vaultId,
boolean match)
Matches enablers mapped to the vault.
|
boolean |
supportsRuledAuthorizationQuery()
Tests if an
AuthorizationQuery is available. |
boolean |
supportsVaultQuery()
Tests if a
VaultQuery is available. |
clearCyclicEventIdTerms, clearCyclicEventTerms, clearDemographicIdTerms, clearDemographicTerms, clearEventIdTerms, clearEventTerms, clearScheduleIdTerms, clearScheduleTerms, getCyclicEventQuery, getDemographicQuery, getEventQuery, getScheduleQuery, matchAnyCyclicEvent, matchAnyDemographic, matchAnyEvent, matchAnySchedule, matchCyclicEventId, matchDemographicId, matchEventId, matchScheduleId, supportsCyclicEventQuery, supportsDemographicQuery, supportsEventQuery, supportsScheduleQuery
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
clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate
void matchRuledAuthorizationId(Id authorizationId, boolean match)
authorizationId
- the authorization Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- authorizationId
is null
mandatory
- This method must be implemented. void clearRuledAuthorizationIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsRuledAuthorizationQuery()
AuthorizationQuery
is available. true
if an authorization query is available,
false
otherwisemandatory
- This method must be implemented. AuthorizationQuery getRuledAuthorizationQuery()
OR
term.UnimplementedException
-
supportsRuledAuthorizationQuery()
is false
optional
- This method must be implemented if
supportsRuledAuthorizationQuery()
is true.
void matchAnyRuledAuthorization(boolean match)
match
- true
for enablers mapped to any
authorization, false
to match enablers mapped
to no authorizationsmandatory
- This method must be implemented. void clearRuledAuthorizationTerms()
mandatory
- This method must be implemented. void matchVaultId(Id vaultId, boolean match)
vaultId
- the 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. AuthorizationEnablerQueryRecord getAuthorizationEnablerQueryRecord(Type authorizationEnablerRecordType) throws OperationFailedException
AuthorizationEnabler
record Type.
Multiple record retrievals produce a nested OR
term.authorizationEnablerRecordType
- an authorization enabler record
typeNullArgumentException
-
authorizationEnablerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(authorizationEnablerRecordType)
is
false
mandatory
- This method must be implemented.