org.osid.control.rules

Interface InputEnablerQuery

All Superinterfaces:

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

public interface InputEnablerQuery
extends OsidEnablerQuery

This is the query for searching input 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	clearRuledInputIdTerms() Clears the input Id query terms.
void	clearRuledInputTerms() Clears the input query terms.
void	clearSystemIdTerms() Clears the system Id query terms.
void	clearSystemTerms() Clears the system query terms.
InputEnablerQueryRecord	getInputEnablerQueryRecord(Type inputEnablerRecordType) Gets the input enabler query record corresponding to the given InputEnabler record Type.
InputQuery	getRuledInputQuery() Gets the query for an input.
SystemQuery	getSystemQuery() Gets the query for a system.
void	matchAnyRuledInput(boolean match) Matches enablers mapped to any input.
void	matchRuledInputId(Id inputId, boolean match) Matches enablers mapped to the input.
void	matchSystemId(Id systemId, boolean match) Matches enablers mapped to the system.
boolean	supportsRuledInputQuery() Tests if an InputQuery 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

matchRuledInputId

void matchRuledInputId(Id inputId,
                     boolean match)

Matches enablers mapped to the input.

Parameters:

inputId - the device Id

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

Throws:

NullArgumentException - inputId is null

Compliance:

mandatory - This method must be implemented.

clearRuledInputIdTerms

void clearRuledInputIdTerms()

Clears the input Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRuledInputQuery

boolean supportsRuledInputQuery()

Tests if an InputQuery is available.

Returns:

true if an input query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuledInputQuery

InputQuery getRuledInputQuery()

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

Returns:

the input query

Throws:

UnimplementedException - supportsRuledInputQuery() is false

Compliance:

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

matchAnyRuledInput

void matchAnyRuledInput(boolean match)

Matches enablers mapped to any input.

Parameters:

match - true for enablers mapped to any input, false to match enablers mapped to no inputs

Compliance:

mandatory - This method must be implemented.

clearRuledInputTerms

void clearRuledInputTerms()

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

getInputEnablerQueryRecord

InputEnablerQueryRecord getInputEnablerQueryRecord(Type inputEnablerRecordType)
                                                   throws OperationFailedException

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

Parameters:

inputEnablerRecordType - an input enabler record type

Returns:

the input enabler query record

Throws:

NullArgumentException - inputEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(inputEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.