org.osid.authorization.rules

Interface AuthorizationEnablerQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidEnablerQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidOperableQuery, OsidQuery, OsidRuleQuery, OsidTemporalQuery, Suppliable

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.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidEnablerQuery

clearCyclicEventIdTerms, clearCyclicEventTerms, clearDemographicIdTerms, clearDemographicTerms, clearEventIdTerms, clearEventTerms, clearScheduleIdTerms, clearScheduleTerms, getCyclicEventQuery, getDemographicQuery, getEventQuery, getScheduleQuery, matchAnyCyclicEvent, matchAnyDemographic, matchAnyEvent, matchAnySchedule, matchCyclicEventId, matchDemographicId, matchEventId, matchScheduleId, supportsCyclicEventQuery, supportsDemographicQuery, supportsEventQuery, supportsScheduleQuery

Methods inherited from interface org.osid.OsidRuleQuery

clearRuleIdTerms, clearRuleTerms, getRuleQuery, matchAnyRule, matchRuleId, supportsRuleQuery

Methods inherited from interface org.osid.OsidObjectQuery

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

Methods inherited from interface org.osid.OsidIdentifiableQuery

clearIdTerms, matchId

Methods inherited from interface org.osid.OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Methods inherited from interface org.osid.OsidOperableQuery

clearActiveTerms, clearDisabledTerms, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational

Methods inherited from interface org.osid.OsidTemporalQuery

clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate

Method Detail

matchRuledAuthorizationId

void matchRuledAuthorizationId(Id authorizationId,
                             boolean match)

Matches enablers mapped to an authorization.

Parameters:

authorizationId - the authorization Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - authorizationId is null

Compliance:

mandatory - This method must be implemented.

clearRuledAuthorizationIdTerms

void clearRuledAuthorizationIdTerms()

Clears the authorization Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRuledAuthorizationQuery

boolean supportsRuledAuthorizationQuery()

Tests if an AuthorizationQuery is available.

Returns:

true if an authorization query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuledAuthorizationQuery

AuthorizationQuery getRuledAuthorizationQuery()

Gets the query for an authorization. Multiple retrievals produce a nested OR term.

Returns:

the authorization query

Throws:

UnimplementedException - supportsRuledAuthorizationQuery() is false

Compliance:

optional - This method must be implemented if supportsRuledAuthorizationQuery() is true.

matchAnyRuledAuthorization

void matchAnyRuledAuthorization(boolean match)

Matches enablers mapped to any authorization.

Parameters:

match - true for enablers mapped to any authorization, false to match enablers mapped to no authorizations

Compliance:

mandatory - This method must be implemented.

clearRuledAuthorizationTerms

void clearRuledAuthorizationTerms()

Clears the authorization query terms.

Compliance:

mandatory - This method must be implemented.

matchVaultId

void matchVaultId(Id vaultId,
                boolean match)

Matches enablers mapped to the vault.

Parameters:

vaultId - the vault Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - vaultId is null

Compliance:

mandatory - This method must be implemented.

clearVaultIdTerms

void clearVaultIdTerms()

Clears the vault Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsVaultQuery

boolean supportsVaultQuery()

Tests if a VaultQuery is available.

Returns:

true if a vault query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getVaultQuery

VaultQuery getVaultQuery()

Gets the query for a vault. Multiple retrievals produce a nested OR term.

Returns:

the vault query

Throws:

UnimplementedException - supportsVaultQuery() is false

Compliance:

optional - This method must be implemented if supportsVaultQuery() is true.

clearVaultTerms

void clearVaultTerms()

Clears the vault query terms.

Compliance:

mandatory - This method must be implemented.

getAuthorizationEnablerQueryRecord

AuthorizationEnablerQueryRecord getAuthorizationEnablerQueryRecord(Type authorizationEnablerRecordType)
                                                                   throws OperationFailedException

Gets the authorization enabler query record corresponding to the given AuthorizationEnabler record Type. Multiple record retrievals produce a nested OR term.

Parameters:

authorizationEnablerRecordType - an authorization enabler record type

Returns:

the authorization enabler query record

Throws:

NullArgumentException - authorizationEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(authorizationEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.