org.osid.mapping.path.rules

Interface ObstacleEnablerQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidEnablerQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidOperableQueryInspector, OsidQueryInspector, OsidRuleQueryInspector, OsidTemporalQueryInspector

public interface ObstacleEnablerQueryInspector
extends OsidEnablerQueryInspector

This is the query interface for examining obstacle enabler queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getMapIdTerms() Gets the map Id query terms.
MapQueryInspector[]	getMapTerms() Gets the map query terms.
ObstacleEnablerQueryInspectorRecord	getObstacleEnablerQueryInspectorRecord(Type obstacleEnablerRecordType) Gets the obstacle enabler query inspector record corresponding to the given ObstacleEnabler record Type.
IdTerm[]	getRuledObstacleIdTerms() Gets the obstacle Id query terms.
ObstacleQueryInspector[]	getRuledObstacleTerms() Gets the obstacle query terms.

Methods inherited from interface org.osid.OsidEnablerQueryInspector

getCyclicEventIdTerms, getCyclicEventTerms, getDemographicIdTerms, getDemographicTerms, getEventIdTerms, getEventTerms, getScheduleIdTerms, getScheduleTerms

Methods inherited from interface org.osid.OsidRuleQueryInspector

getRuleIdTerms, getRuleTerms

Methods inherited from interface org.osid.OsidObjectQueryInspector

getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTerms

Methods inherited from interface org.osid.OsidIdentifiableQueryInspector

getIdTerms

Methods inherited from interface org.osid.OsidExtensibleQueryInspector

getRecordTypeTerms

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQueryInspector

getAnyTerms, getKeywordTerms

Methods inherited from interface org.osid.OsidOperableQueryInspector

getActiveTerms, getDisabledTerms, getEnabledTerms, getOperationalTerms

Methods inherited from interface org.osid.OsidTemporalQueryInspector

getDateTerms, getEffectiveTerms, getEndDateTerms, getStartDateTerms

Method Detail

getRuledObstacleIdTerms

IdTerm[] getRuledObstacleIdTerms()

Gets the obstacle Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRuledObstacleTerms

ObstacleQueryInspector[] getRuledObstacleTerms()

Gets the obstacle query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getMapIdTerms

IdTerm[] getMapIdTerms()

Gets the map Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getMapTerms

MapQueryInspector[] getMapTerms()

Gets the map query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getObstacleEnablerQueryInspectorRecord

ObstacleEnablerQueryInspectorRecord getObstacleEnablerQueryInspectorRecord(Type obstacleEnablerRecordType)
                                                                           throws OperationFailedException

Gets the obstacle enabler query inspector record corresponding to the given ObstacleEnabler record Type.

Parameters:

obstacleEnablerRecordType - an obstacle enabler record type

Returns:

the obstacle enabler query inspector record

Throws:

NullArgumentException - obstacleEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(obstacleEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.