org.osid.mapping.path.rules

Interface SpeedZoneEnablerQuery

All Superinterfaces:

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

public interface SpeedZoneEnablerQuery
extends OsidEnablerQuery

This is the query for searching speed zone enablers. Each method match specifies a 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	clearRuledSpeedZoneIdTerms() Clears the speed zone Id query terms.
void	clearRuledSpeedZoneTerms() Clears the speed zone query terms.
MapQuery	getMapQuery() Gets the query for an map.
SpeedZoneQuery	getRuledSpeedZoneQuery() Gets the query for a speed zone.
SpeedZoneEnablerQueryRecord	getSpeedZoneEnablerQueryRecord(Type speedZoneEnablerRecordType) Gets the speed zone enabler query record corresponding to the given SpeedZoneEnabler record Type.
void	matchAnyRuledSpeedZone(boolean match) Matches enablers mapped to any speed zone.
void	matchMapId(Id mapId, boolean match) Matches enablers mapped to the map.
void	matchRuledSpeedZoneId(Id speedZoneId, boolean match) Matches enablers mapped to the speed zone.
boolean	supportsMapQuery() Tests if an MapQuery is available.
boolean	supportsRuledSpeedZoneQuery() Tests if a SpeedZoneQuery 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

matchRuledSpeedZoneId

void matchRuledSpeedZoneId(Id speedZoneId,
                         boolean match)

Matches enablers mapped to the speed zone.

Parameters:

speedZoneId - the speed zone Id

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

Throws:

NullArgumentException - speedZoneId is null

Compliance:

mandatory - This method must be implemented.

clearRuledSpeedZoneIdTerms

void clearRuledSpeedZoneIdTerms()

Clears the speed zone Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRuledSpeedZoneQuery

boolean supportsRuledSpeedZoneQuery()

Tests if a SpeedZoneQuery is available.

Returns:

true if a speed zone query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuledSpeedZoneQuery

SpeedZoneQuery getRuledSpeedZoneQuery()

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

Returns:

the speed zone query

Throws:

UnimplementedException - supportsRuledSpeedZoneQuery() is false

Compliance:

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

matchAnyRuledSpeedZone

void matchAnyRuledSpeedZone(boolean match)

Matches enablers mapped to any speed zone.

Parameters:

match - true for enablers mapped to any speed zone, false to match enablers mapped to no speed zones

Compliance:

mandatory - This method must be implemented.

clearRuledSpeedZoneTerms

void clearRuledSpeedZoneTerms()

Clears the speed zone query terms.

Compliance:

mandatory - This method must be implemented.

matchMapId

void matchMapId(Id mapId,
              boolean match)

Matches enablers mapped to the 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.

getSpeedZoneEnablerQueryRecord

SpeedZoneEnablerQueryRecord getSpeedZoneEnablerQueryRecord(Type speedZoneEnablerRecordType)
                                                           throws OperationFailedException

Gets the speed zone enabler query record corresponding to the given SpeedZoneEnabler record Type. Multiple record retrievals produce a nested OR term.

Parameters:

speedZoneEnablerRecordType - a speed zone enabler record type

Returns:

the speed zone enabler query record

Throws:

NullArgumentException - speedZoneEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(speedZoneEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.