org.osid.control.rules

Interface TriggerEnablerQuery

All Superinterfaces:

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

public interface TriggerEnablerQuery
extends OsidEnablerQuery

This is the query for searching trigger 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	clearRuledTriggerIdTerms() Clears the trigger Id query terms.
void	clearRuledTriggerTerms() Clears the trigger query terms.
void	clearSystemIdTerms() Clears the system Id query terms.
void	clearSystemTerms() Clears the system query terms.
TriggerQuery	getRuledTriggerQuery() Gets the query for a trigger.
SystemQuery	getSystemQuery() Gets the query for a system.
TriggerEnablerQueryRecord	getTriggerEnablerQueryRecord(Type triggerEnablerRecordType) Gets the trigger enabler query record corresponding to the given TriggerEnabler record Type.
void	matchAnyRuledTrigger(boolean match) Matches enablers mapped to any trigger.
void	matchRuledTriggerId(Id triggerId, boolean match) Matches enablers mapped to the trigger.
void	matchSystemId(Id systemId, boolean match) Matches enablers mapped to the system.
boolean	supportsRuledTriggerQuery() Tests if a TriggerQuery 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

matchRuledTriggerId

void matchRuledTriggerId(Id triggerId,
                       boolean match)

Matches enablers mapped to the trigger.

Parameters:

triggerId - the trigger Id

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

Throws:

NullArgumentException - triggerId is null

Compliance:

mandatory - This method must be implemented.

clearRuledTriggerIdTerms

void clearRuledTriggerIdTerms()

Clears the trigger Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRuledTriggerQuery

boolean supportsRuledTriggerQuery()

Tests if a TriggerQuery is available.

Returns:

true if a trigger query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuledTriggerQuery

TriggerQuery getRuledTriggerQuery()

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

Returns:

the trigger query

Throws:

UnimplementedException - supportsRuledTriggerQuery() is false

Compliance:

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

matchAnyRuledTrigger

void matchAnyRuledTrigger(boolean match)

Matches enablers mapped to any trigger.

Parameters:

match - true for enablers mapped to any trigger, false to match enablers mapped to no triggers

Compliance:

mandatory - This method must be implemented.

clearRuledTriggerTerms

void clearRuledTriggerTerms()

Clears the trigger 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.

getTriggerEnablerQueryRecord

TriggerEnablerQueryRecord getTriggerEnablerQueryRecord(Type triggerEnablerRecordType)
                                                       throws OperationFailedException

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

Parameters:

triggerEnablerRecordType - a trigger enabler record type

Returns:

the trigger enabler query record

Throws:

NullArgumentException - triggerEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(triggerEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.