org.osid.mapping.path.rules

Interface ObstacleEnablerQuery

All Superinterfaces:

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

public interface ObstacleEnablerQuery
extends OsidEnablerQuery

This is the query for searching obstacle 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	clearRuledObstacleIdTerms() Clears the obstacle Id query terms.
void	clearRuledObstacleTerms() Clears the obstacle query terms.
MapQuery	getMapQuery() Gets the query for an map.
ObstacleEnablerQueryRecord	getObstacleEnablerQueryRecord(Type obstacleEnablerRecordType) Gets the obstacle enabler query record corresponding to the given ObstacleEnabler record Type.
ObstacleQuery	getRuledObstacleQuery() Gets the query for an obstacle.
void	matchAnyRuledObstacle(boolean match) Matches rules mapped to any obstacle.
void	matchMapId(Id mapId, boolean match) Matches enablers mapped to an map.
void	matchRuledObstacleId(Id obstacleId, boolean match) Matches enablers mapped to an obstacle.
boolean	supportsMapQuery() Tests if an MapQuery is available.
boolean	supportsRuledObstacleQuery() Tests if an ObstacleQuery 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

matchRuledObstacleId

void matchRuledObstacleId(Id obstacleId,
                        boolean match)

Matches enablers mapped to an obstacle.

Parameters:

obstacleId - the obstacle Id

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

Throws:

NullArgumentException - obstacleId is null

Compliance:

mandatory - This method must be implemented.

clearRuledObstacleIdTerms

void clearRuledObstacleIdTerms()

Clears the obstacle Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRuledObstacleQuery

boolean supportsRuledObstacleQuery()

Tests if an ObstacleQuery is available.

Returns:

true if an obstacle query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuledObstacleQuery

ObstacleQuery getRuledObstacleQuery()

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

Returns:

the obstacle query

Throws:

UnimplementedException - supportsRuledObstacleQuery() is false

Compliance:

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

matchAnyRuledObstacle

void matchAnyRuledObstacle(boolean match)

Matches rules mapped to any obstacle.

Parameters:

match - true for rules mapped to any obstacle, false to match rules mapped to no obstacles

Compliance:

mandatory - This method must be implemented.

clearRuledObstacleTerms

void clearRuledObstacleTerms()

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

getObstacleEnablerQueryRecord

ObstacleEnablerQueryRecord getObstacleEnablerQueryRecord(Type obstacleEnablerRecordType)
                                                         throws OperationFailedException

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

Parameters:

obstacleEnablerRecordType - an obstacle enabler record type

Returns:

the obstacle enabler query record

Throws:

NullArgumentException - obstacleEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(obstacleEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.