OSID - osid.room.CampusQuery Service Interface Definition

Interface	osid.room.CampusQuery
Implements	`osid.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.`
Method	matchRoomId
Description	Sets the room `Id` for this query to match rooms assigned to campuses.
Parameters	`osid.id.Id`	`roomId`	a room `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`roomId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRoomIdTerms
Description	Clears the room `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRoomQuery
Description	Tests if a room query is available.
Return	`boolean`		`true` if a room query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRoomQuery
Description	Gets the query for a room.
Return	`osid.room.RoomQuery`		the room query
Errors	UNIMPLEMENTED		`supportsRoomQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRoomQuery()` is `true.`
Method	matchAnyRoom
Description	Matches campuses with any room.
Parameters	`boolean`	`match`	`true` to match campuses with any room, `false` to match campuses with no rooms
Compliance	`mandatory`		This method must be implemented.
Method	clearRoomTerms
Description	Clears the room terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchFloorId
Description	Sets the floor `Id` for this query to match rooms assigned to campuses.
Parameters	`osid.id.Id`	`floorId`	a floor `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`floorId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearFloorIdTerms
Description	Clears the floor `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsFloorQuery
Description	Tests if a floor query is available.
Return	`boolean`		`true` if a room query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getFloorQuery
Description	Gets the query for a floor.
Return	`osid.room.FloorQuery`		the floor query
Errors	UNIMPLEMENTED		`supportsFloorQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsFloorQuery()` is `true.`
Method	matchAnyFloor
Description	Matches campuses with any floor.
Parameters	`boolean`	`match`	`true` to match campuses with any floor, `false` to match campuses with no floors
Compliance	`mandatory`		This method must be implemented.
Method	clearFloorTerms
Description	Clears the floor terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchBuildingId
Description	Sets the building `Id` for this query to match rooms assigned to buildings.
Parameters	`osid.id.Id`	`buildingId`	a building `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`buildingId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearBuildingIdTerms
Description	Clears the building `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsBuildingQuery
Description	Tests if a `BuildingQuery` is available.
Return	`boolean`		`true` if a building query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getBuildingQuery
Description	Gets the query for a building query. Multiple retrievals produce a nested `OR` term.
Return	`osid.room.BuildingQuery`		the building query
Errors	UNIMPLEMENTED		`supportsBuildingQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBuildingQuery()` is `true.`
Method	matchAnyBuilding
Description	Matches campuses with any building.
Parameters	`boolean`	`match`	`true` to match campuses with any building, `false` to match campuses with no buildings
Compliance	`mandatory`		This method must be implemented.
Method	clearBuildingTerms
Description	Clears the building terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAncestorCampusId
Description	Sets the campus `Id` for this query to match campuses that have the specified campus as an ancestor.
Parameters	`osid.id.Id`	`campusId`	a campus `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`campusId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorCampusIdTerms
Description	Clears the ancestor campus `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAncestorCampusQuery
Description	Tests if a `CampusQuery` is available.
Return	`boolean`		`true` if a campus query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAncestorCampusQuery
Description	Gets the query for a campus. Multiple retrievals produce a nested `OR` term.
Return	`osid.room.CampusQuery`		the campus query
Errors	UNIMPLEMENTED		`supportsAncestorCampusQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAncestorCampusQuery()` is `true.`
Method	matchAnyAncestorCampus
Description	Matches campuses with any ancestor.
Parameters	`boolean`	`match`	`true` to match campuses with any ancestor, `false` to match root campuses
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorCampusTerms
Description	Clears the ancestor campus terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDescendantCampusId
Description	Sets the campus `Id` for this query to match campuses that have the specified campus as a descendant.
Parameters	`osid.id.Id`	`campusId`	a campus `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`campusId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantCampusIdTerms
Description	Clears the descendant campus `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDescendantCampusQuery
Description	Tests if a `CampusQuery` is available.
Return	`boolean`		`true` if a campus query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDescendantCampusQuery
Description	Gets the query for a campus. Multiple retrievals produce a nested `OR` term.
Return	`osid.room.CampusQuery`		the campus query
Errors	UNIMPLEMENTED		`supportsDescendantCampusQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDescendantCampusQuery()` is `true.`
Method	matchAnyDescendantCampus
Description	Matches campuses with any descendant.
Parameters	`boolean`	`match`	`true` to match campuses with any descendant, `false` to match leaf campuses
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantCampusTerms
Description	Clears the descendant campus terms.
Compliance	`mandatory`		This method must be implemented.
Method	getCampusQueryRecord
Description	Gets the campus query record corresponding to the given `Campus` record `Type.` Multiple record retrievals produce a nested boolean `OR` term.
Parameters	`osid.type.Type`	`campusRecordType`	a campus record type
Return	`osid.room.records.CampusQueryRecord`		the campus query record
Errors	NULL_ARGUMENT		`campusRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(campusRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.