OSID Logo
OSID Specifications
room package
Version 3.0.0
Release Candidate Preview
Interfaceosid.room.CampusQuery
Implementsosid.OsidCatalogQuery
Description

This is the query for searching for campuses. Each method specifies an AND term while multiple invocations of the same method produce a nested OR.

MethodmatchRoomId
Description

Sets the room Id for this query to match rooms assigned to campuses.

Parametersosid.id.IdroomIda room Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT roomId is null
CompliancemandatoryThis method must be implemented.
MethodclearRoomIdTerms
Description

Clears the room Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRoomQuery
Description

Tests if a room query is available.

Returnboolean true if a room query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetRoomQuery
Description

Gets the query for a room.

Returnosid.room.RoomQuerythe room query
ErrorsUNIMPLEMENTED supportsRoomQuery() is false
ComplianceoptionalThis method must be implemented if supportsRoomQuery() is true.
MethodmatchAnyRoom
Description

Matches campuses with any room.

Parametersbooleanmatch true to match campuses with any room, false to match campuses with no rooms
CompliancemandatoryThis method must be implemented.
MethodclearRoomTerms
Description

Clears the room terms.

CompliancemandatoryThis method must be implemented.
MethodmatchFloorId
Description

Sets the floor Id for this query to match rooms assigned to campuses.

Parametersosid.id.IdfloorIda floor Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT floorId is null
CompliancemandatoryThis method must be implemented.
MethodclearFloorIdTerms
Description

Clears the floor Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsFloorQuery
Description

Tests if a floor query is available.

Returnboolean true if a room query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetFloorQuery
Description

Gets the query for a floor.

Returnosid.room.FloorQuerythe floor query
ErrorsUNIMPLEMENTED supportsFloorQuery() is false
ComplianceoptionalThis method must be implemented if supportsFloorQuery() is true.
MethodmatchAnyFloor
Description

Matches campuses with any floor.

Parametersbooleanmatch true to match campuses with any floor, false to match campuses with no floors
CompliancemandatoryThis method must be implemented.
MethodclearFloorTerms
Description

Clears the floor terms.

CompliancemandatoryThis method must be implemented.
MethodmatchBuildingId
Description

Sets the building Id for this query to match rooms assigned to buildings.

Parametersosid.id.IdbuildingIda building Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT buildingId is null
CompliancemandatoryThis method must be implemented.
MethodclearBuildingIdTerms
Description

Clears the building Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsBuildingQuery
Description

Tests if a BuildingQuery is available.

Returnboolean true if a building query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetBuildingQuery
Description

Gets the query for a building query. Multiple retrievals produce a nested OR term.

Returnosid.room.BuildingQuerythe building query
ErrorsUNIMPLEMENTED supportsBuildingQuery() is false
ComplianceoptionalThis method must be implemented if supportsBuildingQuery() is true.
MethodmatchAnyBuilding
Description

Matches campuses with any building.

Parametersbooleanmatch true to match campuses with any building, false to match campuses with no buildings
CompliancemandatoryThis method must be implemented.
MethodclearBuildingTerms
Description

Clears the building terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAncestorCampusId
Description

Sets the campus Id for this query to match campuses that have the specified campus as an ancestor.

Parametersosid.id.IdcampusIda campus Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT campusId is null
CompliancemandatoryThis method must be implemented.
MethodclearAncestorCampusIdTerms
Description

Clears the ancestor campus Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAncestorCampusQuery
Description

Tests if a CampusQuery is available.

Returnboolean true if a campus query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAncestorCampusQuery
Description

Gets the query for a campus. Multiple retrievals produce a nested OR term.

Returnosid.room.CampusQuerythe campus query
ErrorsUNIMPLEMENTED supportsAncestorCampusQuery() is false
ComplianceoptionalThis method must be implemented if supportsAncestorCampusQuery() is true.
MethodmatchAnyAncestorCampus
Description

Matches campuses with any ancestor.

Parametersbooleanmatch true to match campuses with any ancestor, false to match root campuses
CompliancemandatoryThis method must be implemented.
MethodclearAncestorCampusTerms
Description

Clears the ancestor campus terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDescendantCampusId
Description

Sets the campus Id for this query to match campuses that have the specified campus as a descendant.

Parametersosid.id.IdcampusIda campus Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT campusId is null
CompliancemandatoryThis method must be implemented.
MethodclearDescendantCampusIdTerms
Description

Clears the descendant campus Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsDescendantCampusQuery
Description

Tests if a CampusQuery is available.

Returnboolean true if a campus query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetDescendantCampusQuery
Description

Gets the query for a campus. Multiple retrievals produce a nested OR term.

Returnosid.room.CampusQuerythe campus query
ErrorsUNIMPLEMENTED supportsDescendantCampusQuery() is false
ComplianceoptionalThis method must be implemented if supportsDescendantCampusQuery() is true.
MethodmatchAnyDescendantCampus
Description

Matches campuses with any descendant.

Parametersbooleanmatch true to match campuses with any descendant, false to match leaf campuses
CompliancemandatoryThis method must be implemented.
MethodclearDescendantCampusTerms
Description

Clears the descendant campus terms.

CompliancemandatoryThis method must be implemented.
MethodgetCampusQueryRecord
Description

Gets the campus query record corresponding to the given Campus record Type. Multiple record retrievals produce a nested boolean OR term.

Parametersosid.type.TypecampusRecordTypea campus record type
Returnosid.room.records.CampusQueryRecordthe campus query record
ErrorsNULL_ARGUMENT campusRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(campusRecordType) is false
CompliancemandatoryThis method must be implemented.