org.osid.room

Interface BuildingQueryInspector

All Superinterfaces:

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

public interface BuildingQueryInspector
extends OsidObjectQueryInspector, OsidTemporalQueryInspector

This is the query inspector for examining for building queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getAddressIdTerms() Gets the address Id terms.
AddressQueryInspector[]	getAddressTerms() Gets the address terms.
BuildingQueryInspectorRecord	getBuildingQueryInspectorRecord(Type buildingRecordType) Gets the building query inspector record corresponding to the given Building record Type.
IdTerm[]	getCampusIdTerms() Gets the campus Id terms.
CampusQueryInspector[]	getCampusTerms() Gets the campus terms.
IdTerm[]	getEnclosingBuildingIdTerms() Gets the enclosing building Id terms.
BuildingQueryInspector[]	getEnclosingBuildingTerms() Gets the enclosing building terms.
DecimalRangeTerm[]	getGrossAreaTerms() Gets the gross area terms.
StringTerm[]	getNumberTerms() Gets the building number terms.
StringTerm[]	getOfficialNameTerms() Gets the offical name terms.
IdTerm[]	getRoomIdTerms() Gets the room Id terms.
RoomQueryInspector[]	getRoomTerms() Gets the 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

getAddressIdTerms

IdTerm[] getAddressIdTerms()

Gets the address Id terms.

Returns:

the address Id terms

Compliance:

mandatory - This method must be implemented.

getAddressTerms

AddressQueryInspector[] getAddressTerms()

Gets the address terms.

Returns:

the address terms

Compliance:

mandatory - This method must be implemented.

getOfficialNameTerms

StringTerm[] getOfficialNameTerms()

Gets the offical name terms.

Returns:

the name terms

Compliance:

mandatory - This method must be implemented.

getNumberTerms

StringTerm[] getNumberTerms()

Gets the building number terms.

Returns:

the number terms

Compliance:

mandatory - This method must be implemented.

getEnclosingBuildingIdTerms

IdTerm[] getEnclosingBuildingIdTerms()

Gets the enclosing building Id terms.

Returns:

the building Id terms

Compliance:

mandatory - This method must be implemented.

getEnclosingBuildingTerms

BuildingQueryInspector[] getEnclosingBuildingTerms()

Gets the enclosing building terms.

Returns:

the building terms

Compliance:

mandatory - This method must be implemented.

getGrossAreaTerms

DecimalRangeTerm[] getGrossAreaTerms()

Gets the gross area terms.

Returns:

the gross area terms

Compliance:

mandatory - This method must be implemented.

getRoomIdTerms

IdTerm[] getRoomIdTerms()

Gets the room Id terms.

Returns:

the room Id terms

Compliance:

mandatory - This method must be implemented.

getRoomTerms

RoomQueryInspector[] getRoomTerms()

Gets the room terms.

Returns:

the room 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.

getBuildingQueryInspectorRecord

BuildingQueryInspectorRecord getBuildingQueryInspectorRecord(Type buildingRecordType)
                                                             throws OperationFailedException

Gets the building query inspector record corresponding to the given Building record Type.

Parameters:

buildingRecordType - a building record type

Returns:

the building query inspector record

Throws:

NullArgumentException - buildingRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(buildingRecordType) is false

Compliance:

mandatory - This method must be implemented.