org.osid.control.rules

Interface ActionEnablerQuery

All Superinterfaces:

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

public interface ActionEnablerQuery
extends OsidEnablerQuery

This is the query for searching action 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	clearRuledActionIdTerms() Clears the action Id query terms.
void	clearRuledActionTerms() Clears the action query terms.
void	clearSystemIdTerms() Clears the system Id query terms.
void	clearSystemTerms() Clears the system query terms.
ActionEnablerQueryRecord	getActionEnablerQueryRecord(Type actionEnablerRecordType) Gets the action enabler query record corresponding to the given ActionEnabler record Type.
ActionQuery	getRuledActionQuery() Gets the query for an action.
SystemQuery	getSystemQuery() Gets the query for a system.
void	matchAnyRuledAction(boolean match) Matches enablers mapped to any action.
void	matchRuledActionId(Id actionId, boolean match) Matches enablers mapped to the action.
void	matchSystemId(Id systemId, boolean match) Matches enablers mapped to the system.
boolean	supportsRuledActionQuery() Tests if an ActionQuery is available.
boolean	supportsSystemQuery() Tests if a SystemQuery 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

matchRuledActionId

void matchRuledActionId(Id actionId,
                      boolean match)

Matches enablers mapped to the action.

Parameters:

actionId - the action Id

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

Throws:

NullArgumentException - actionId is null

Compliance:

mandatory - This method must be implemented.

clearRuledActionIdTerms

void clearRuledActionIdTerms()

Clears the action Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRuledActionQuery

boolean supportsRuledActionQuery()

Tests if an ActionQuery is available.

Returns:

true if an action query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuledActionQuery

ActionQuery getRuledActionQuery()

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

Returns:

the action query

Throws:

UnimplementedException - supportsRuledActionQuery() is false

Compliance:

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

matchAnyRuledAction

void matchAnyRuledAction(boolean match)

Matches enablers mapped to any action.

Parameters:

match - true for enablers mapped to any action, false to match enablers mapped to no actions

Compliance:

mandatory - This method must be implemented.

clearRuledActionTerms

void clearRuledActionTerms()

Clears the action query terms.

Compliance:

mandatory - This method must be implemented.

matchSystemId

void matchSystemId(Id systemId,
                 boolean match)

Matches enablers mapped to the system.

Parameters:

systemId - the system Id

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

Throws:

NullArgumentException - systemId is null

Compliance:

mandatory - This method must be implemented.

clearSystemIdTerms

void clearSystemIdTerms()

Clears the system Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsSystemQuery

boolean supportsSystemQuery()

Tests if a SystemQuery is available.

Returns:

true if a system query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getSystemQuery

SystemQuery getSystemQuery()

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

Returns:

the system query

Throws:

UnimplementedException - supportsSystemQuery() is false

Compliance:

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

clearSystemTerms

void clearSystemTerms()

Clears the system query terms.

Compliance:

mandatory - This method must be implemented.

getActionEnablerQueryRecord

ActionEnablerQueryRecord getActionEnablerQueryRecord(Type actionEnablerRecordType)
                                                     throws OperationFailedException

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

Parameters:

actionEnablerRecordType - an action enabler record type

Returns:

the action enabler query record

Throws:

NullArgumentException - actionEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(actionEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.