org.osid.room

Interface RoomQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidSubjugateableQueryInspector, OsidTemporalQueryInspector

public interface RoomQueryInspector
extends OsidObjectQueryInspector, OsidTemporalQueryInspector, OsidSubjugateableQueryInspector

The query inspector for examining room queries.

Method Summary

Methods

Modifier and Type	Method and Description
DecimalRangeTerm[]	getAreaTerms() Gets the area terms.
IdTerm[]	getBuildingIdTerms() Gets the building Id terms.
BuildingQueryInspector[]	getBuildingTerms() Gets the building terms.
IdTerm[]	getCampusIdTerms() Gets the campus Id terms.
CampusQueryInspector[]	getCampusTerms() Gets the campus terms.
StringTerm[]	getCodeTerms() Gets the room code number terms.
StringTerm[]	getDesignatedNameTerms() Gets the offical name terms.
IdTerm[]	getEnclosingRoomIdTerms() Gets the enclosing room Id terms.
RoomQueryInspector[]	getEnclosingRoomTerms() Gets the enclosing room terms.
IdTerm[]	getFloorIdTerms() Gets the floor Id terms.
FloorQueryInspector[]	getFloorTerms() Gets the floor terms.
CardinalRangeTerm[]	getOccupancyLimitTerms() Gets the occupancy limit terms.
IdTerm[]	getResourceIdTerms() Gets the resource Id terms.
ResourceQueryInspector[]	getResourceTerms() Gets the resource terms.
StringTerm[]	getRoomNumberTerms() Gets the room building number terms.
RoomQueryInspectorRecord	getRoomQueryInspectorRecord(Type roomRecordType) Gets the room query inspector record corresponding to the given Room record Type.
IdTerm[]	getSubdivisionIdTerms() Gets the subdivision room Id terms.
RoomQueryInspector[]	getSubdivisionTerms() Gets the subdivision room terms.

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.OsidTemporalQueryInspector

getDateTerms, getEffectiveTerms, getEndDateTerms, getStartDateTerms

Method Detail

getBuildingIdTerms

IdTerm[] getBuildingIdTerms()

Gets the building Id terms.

Returns:

the building Id terms

Compliance:

mandatory - This method must be implemented.

getBuildingTerms

BuildingQueryInspector[] getBuildingTerms()

Gets the building terms.

Returns:

the building terms

Compliance:

mandatory - This method must be implemented.

getFloorIdTerms

IdTerm[] getFloorIdTerms()

Gets the floor Id terms.

Returns:

the floor Id terms

Compliance:

mandatory - This method must be implemented.

getFloorTerms

FloorQueryInspector[] getFloorTerms()

Gets the floor terms.

Returns:

the floor terms

Compliance:

mandatory - This method must be implemented.

getEnclosingRoomIdTerms

IdTerm[] getEnclosingRoomIdTerms()

Gets the enclosing room Id terms.

Returns:

the enclosing room Id terms

Compliance:

mandatory - This method must be implemented.

getEnclosingRoomTerms

RoomQueryInspector[] getEnclosingRoomTerms()

Gets the enclosing room terms.

Returns:

the enclosing room terms

Compliance:

mandatory - This method must be implemented.

getSubdivisionIdTerms

IdTerm[] getSubdivisionIdTerms()

Gets the subdivision room Id terms.

Returns:

the subdivision room Id terms

Compliance:

mandatory - This method must be implemented.

getSubdivisionTerms

RoomQueryInspector[] getSubdivisionTerms()

Gets the subdivision room terms.

Returns:

the subdivision room terms

Compliance:

mandatory - This method must be implemented.

getDesignatedNameTerms

StringTerm[] getDesignatedNameTerms()

Gets the offical name terms.

Returns:

the name terms

Compliance:

mandatory - This method must be implemented.

getRoomNumberTerms

StringTerm[] getRoomNumberTerms()

Gets the room building number terms.

Returns:

the room number terms

Compliance:

mandatory - This method must be implemented.

getCodeTerms

StringTerm[] getCodeTerms()

Gets the room code number terms.

Returns:

the room code terms

Compliance:

mandatory - This method must be implemented.

getAreaTerms

DecimalRangeTerm[] getAreaTerms()

Gets the area terms.

Returns:

the area terms

Compliance:

mandatory - This method must be implemented.

getOccupancyLimitTerms

CardinalRangeTerm[] getOccupancyLimitTerms()

Gets the occupancy limit terms.

Returns:

the occupancy limit terms

Compliance:

mandatory - This method must be implemented.

getResourceIdTerms

IdTerm[] getResourceIdTerms()

Gets the resource Id terms.

Returns:

the resource Id terms

Compliance:

mandatory - This method must be implemented.

getResourceTerms

ResourceQueryInspector[] getResourceTerms()

Gets the resource terms.

Returns:

the resource terms

Compliance:

mandatory - This method must be implemented.

getCampusIdTerms

IdTerm[] getCampusIdTerms()

Gets the campus Id terms.

Returns:

the campus Id terms

Compliance:

mandatory - This method must be implemented.

getCampusTerms

CampusQueryInspector[] getCampusTerms()

Gets the campus terms.

Returns:

the campus terms

Compliance:

mandatory - This method must be implemented.

getRoomQueryInspectorRecord

RoomQueryInspectorRecord getRoomQueryInspectorRecord(Type roomRecordType)
                                                     throws OperationFailedException

Gets the room query inspector record corresponding to the given Room record Type.

Parameters:

roomRecordType - a room record type

Returns:

the room query inspector record

Throws:

NullArgumentException - roomRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(roomRecordType) is false

Compliance:

mandatory - This method must be implemented.