org.osid.mapping.path

Interface SignalQueryInspector

All Superinterfaces:

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

public interface SignalQueryInspector
extends OsidRuleQueryInspector

This is the query inspector interface for examining signal queries.

Method Summary

Methods

Modifier and Type	Method and Description
SpatialUnitTerm[]	getContainingSpatialUnitTerms() Gets the containing spatial unit query terms.
CoordinateTerm[]	getCoordinateTerms() Gets the coordinate query terms.
IdTerm[]	getMapIdTerms() Gets the map Id query terms.
MapQueryInspector[]	getMapTerms() Gets the map query terms.
IdTerm[]	getPathIdTerms() Gets the path Id query terms.
PathQueryInspector[]	getPathTerms() Gets the path query terms.
SignalQueryInspectorRecord	getSignalQueryInspectorRecord(Type signalRecordType) Gets the signal query inspector record corresponding to the given Signal record Type.
IdTerm[]	getStateIdTerms() Gets the state Id query terms.
StateQueryInspector[]	getStateTerms() Gets the state query terms.

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, 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

Method Detail

getPathIdTerms

IdTerm[] getPathIdTerms()

Gets the path Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getPathTerms

PathQueryInspector[] getPathTerms()

Gets the path query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getCoordinateTerms

CoordinateTerm[] getCoordinateTerms()

Gets the coordinate query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getContainingSpatialUnitTerms

SpatialUnitTerm[] getContainingSpatialUnitTerms()

Gets the containing spatial unit query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getStateIdTerms

IdTerm[] getStateIdTerms()

Gets the state Id query terms.

Specified by:

getStateIdTerms in interface OsidObjectQueryInspector

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getStateTerms

StateQueryInspector[] getStateTerms()

Gets the state query terms.

Specified by:

getStateTerms in interface OsidObjectQueryInspector

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.

getSignalQueryInspectorRecord

SignalQueryInspectorRecord getSignalQueryInspectorRecord(Type signalRecordType)
                                                         throws OperationFailedException

Gets the signal query inspector record corresponding to the given Signal record Type.

Parameters:

signalRecordType - a signal record type

Returns:

the signal query inspector record

Throws:

NullArgumentException - signalRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(signalRecordType) is false

Compliance:

mandatory - This method must be implemented.