org.osid.room

Interface CampusQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidCatalogQueryInspector, OsidExtensibleQueryInspector, OsidFederateableQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidSourceableQueryInspector

public interface CampusQueryInspector
extends OsidCatalogQueryInspector

This is the query inspector for examining for campus queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getAncestorCampusIdTerms() Gets the ancestor campus Id terms.
CampusQueryInspector[]	getAncestorCampusTerms() Gets the ancestor campus terms.
IdTerm[]	getBuildingIdTerms() Gets the building Id terms.
BuildingQueryInspector[]	getBuildingTerms() Gets the building terms.
CampusQueryInspectorRecord	getCampusQueryInspectorRecord(Type campusRecordType) Gets the campus query inspector record corresponding to the given Campus record Type.
IdTerm[]	getDescendantCampusIdTerms() Gets the descendant campus Id terms.
CampusQueryInspector[]	getDescendantCampusTerms() Gets the descendant campus terms.
IdTerm[]	getFloorIdTerms() Gets the floor Id terms.
FloorQueryInspector[]	getFloorTerms() Gets the floor 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.OsidSourceableQueryInspector

getBrandingIdTerms, getBrandingTerms, getLicenseTerms, getProviderIdTerms, getProviderTerms

Method Detail

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.

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.

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.

getAncestorCampusIdTerms

IdTerm[] getAncestorCampusIdTerms()

Gets the ancestor campus Id terms.

Returns:

the ancestor campus Id terms

Compliance:

mandatory - This method must be implemented.

getAncestorCampusTerms

CampusQueryInspector[] getAncestorCampusTerms()

Gets the ancestor campus terms.

Returns:

the ancestor campus terms

Compliance:

mandatory - This method must be implemented.

getDescendantCampusIdTerms

IdTerm[] getDescendantCampusIdTerms()

Gets the descendant campus Id terms.

Returns:

the descendant campus Id terms

Compliance:

mandatory - This method must be implemented.

getDescendantCampusTerms

CampusQueryInspector[] getDescendantCampusTerms()

Gets the descendant campus terms.

Returns:

the descendant campus terms

Compliance:

mandatory - This method must be implemented.

getCampusQueryInspectorRecord

CampusQueryInspectorRecord getCampusQueryInspectorRecord(Type campusRecordType)
                                                         throws OperationFailedException

Gets the campus query inspector record corresponding to the given Campus record Type.

Parameters:

campusRecordType - a campus record type

Returns:

the campus query inspector record

Throws:

NullArgumentException - campusRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(campusRecordType) is false

Compliance:

mandatory - This method must be implemented.