org.osid.mapping.path.rules

Interface SignalEnablerQuery

All Superinterfaces:

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

public interface SignalEnablerQuery
extends OsidEnablerQuery

This is the query for searching signal 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	clearMapIdTerms() Clears the map Id query terms.
void	clearMapTerms() Clears the map query terms.
void	clearRuledSignalIdTerms() Clears the signal Id query terms.
void	clearRuledSignalTerms() Clears the signal query terms.
MapQuery	getMapQuery() Gets the query for an map.
SignalQuery	getRuledSignalQuery() Gets the query for a signal.
SignalEnablerQueryRecord	getSignalEnablerQueryRecord(Type signalEnablerRecordType) Gets the signal enabler query record corresponding to the given SignalEnabler record Type.
void	matchAnyRuledSignal(boolean match) Matches rules mapped to any signal.
void	matchMapId(Id mapId, boolean match) Matches enablers mapped to an map.
void	matchRuledSignalId(Id signalId, boolean match) Matches enablers mapped to a signal.
boolean	supportsMapQuery() Tests if an MapQuery is available.
boolean	supportsRuledSignalQuery() Tests if a SignalQuery 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

matchRuledSignalId

void matchRuledSignalId(Id signalId,
                      boolean match)

Matches enablers mapped to a signal.

Parameters:

signalId - the signal Id

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

Throws:

NullArgumentException - signalId is null

Compliance:

mandatory - This method must be implemented.

clearRuledSignalIdTerms

void clearRuledSignalIdTerms()

Clears the signal Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRuledSignalQuery

boolean supportsRuledSignalQuery()

Tests if a SignalQuery is available.

Returns:

true if a signal query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuledSignalQuery

SignalQuery getRuledSignalQuery()

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

Returns:

the signal query

Throws:

UnimplementedException - supportsRuledSignalQuery() is false

Compliance:

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

matchAnyRuledSignal

void matchAnyRuledSignal(boolean match)

Matches rules mapped to any signal.

Parameters:

match - true for rules mapped to any signal, false to match rules mapped to no signals

Compliance:

mandatory - This method must be implemented.

clearRuledSignalTerms

void clearRuledSignalTerms()

Clears the signal query terms.

Compliance:

mandatory - This method must be implemented.

matchMapId

void matchMapId(Id mapId,
              boolean match)

Matches enablers mapped to an map.

Parameters:

mapId - the map Id

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

Throws:

NullArgumentException - mapId is null

Compliance:

mandatory - This method must be implemented.

clearMapIdTerms

void clearMapIdTerms()

Clears the map Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsMapQuery

boolean supportsMapQuery()

Tests if an MapQuery is available.

Returns:

true if an map query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getMapQuery

MapQuery getMapQuery()

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

Returns:

the map query

Throws:

UnimplementedException - supportsMapQuery() is false

Compliance:

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

clearMapTerms

void clearMapTerms()

Clears the map query terms.

Compliance:

mandatory - This method must be implemented.

getSignalEnablerQueryRecord

SignalEnablerQueryRecord getSignalEnablerQueryRecord(Type signalEnablerRecordType)
                                                     throws OperationFailedException

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

Parameters:

signalEnablerRecordType - a signal enabler record type

Returns:

the signal enabler query record

Throws:

NullArgumentException - signalEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(signalEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.