OSID - osid.room.BuildingQuery Service Interface Definition

Interface	osid.room.BuildingQuery
Implements	`osid.OsidObjectQuery`
Implements	`osid.OsidTemporalQuery`
Description	This is the query for searching for buildings. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR.`
Method	matchAddressId
Description	Sets an address `Id.`
Parameters	`osid.id.Id`	`addressId`	an address `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`addressId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAddressIdTerms
Description	Clears the address `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAddressQuery
Description	Tests if an `AddressQuery` is available.
Return	`boolean`		`true` if an address query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAddressQuery
Description	Gets the query for an address query. Multiple retrievals produce a nested `OR` term.
Return	`osid.contact.AddressQuery`		the address query
Errors	UNIMPLEMENTED		`supportsAddressQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAddressQuery()` is `true.`
Method	matchAnyAddress
Description	Matches any address.
Parameters	`boolean`	`match`	`true` to match buildings with any address, `false` to match buildings with no address
Compliance	`mandatory`		This method must be implemented.
Method	clearAddressTerms
Description	Clears the address terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchOfficialName
Description	Sets a name.
Parameters	`string`	`name`	an official name
	`osid.type.Type`	`stringMatchType`	a string match type
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`name` is not of `stringMatchType`
	NULL_ARGUMENT		`name` is `null`
	UNSUPPORTED		`supportsStringMatchType(stringMatchType)` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyOfficialName
Description	Matches any official name.
Parameters	`boolean`	`match`	`true` to match buildings with any official name, `false` to match buildings with no official name
Compliance	`mandatory`		This method must be implemented.
Method	clearOfficialNameTerms
Description	Clears the official name terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchNumber
Description	Sets a bulding number.
Parameters	`string`	`number`	a number
	`osid.type.Type`	`stringMatchType`	a string match type
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`number` is not of `stringMatchType`
	NULL_ARGUMENT		`number` is `null`
	UNSUPPORTED		`supportsStringMatchType(stringMatchType)` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyNumber
Description	Matches any building number.
Parameters	`boolean`	`match`	`true` to match buildings with any number, `false` to match buildings with no number
Compliance	`mandatory`		This method must be implemented.
Method	clearNumberTerms
Description	Clears the building number terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchEnclosingBuildingId
Description	Sets a building `Id.`
Parameters	`osid.id.Id`	`buildingId`	a building `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`addressId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearEnclosingBuildingIdTerms
Description	Clears the building `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsEnclosingBuildingQuery
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	getEnclosingBuildingQuery
Description	Gets the query for a building query. Multiple retrievals produce a nested `OR` term.
Return	`osid.room.BuildingQuery`		the building query
Errors	UNIMPLEMENTED		`supportsEnclosingBuildingQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEnclosingBuildingQuery()` is `true.`
Method	matchAnyEnclosingBuilding
Description	Matches any building.
Parameters	`boolean`	`match`	`true` to match buildings with any enclosing building, `false` to match buildings with no enclosing building
Compliance	`mandatory`		This method must be implemented.
Method	clearEnclosingBuildingTerms
Description	Clears the enclosing building terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchGrossArea
Description	Matches an area within the given range inclusive.
Parameters	`decimal`	`low`	start of range
	`decimal`	`high`	end of range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`low` is greater than `high`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyGrossArea
Description	Matches any area.
Parameters	`boolean`	`match`	`true` to match buildings with any area, `false` to match buildings with no area assigned
Compliance	`mandatory`		This method must be implemented.
Method	clearGrossAreaTerms
Description	Clears the area terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchRoomId
Description	Sets the room `Id` for this query to match rooms assigned to buildings.
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 building.
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 buildings with any room.
Parameters	`boolean`	`match`	`true` to match buildings with any room, `false` to match buildings 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	matchCampusId
Description	Sets the building `Id` for this query to match rooms assigned to campuses.
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	clearCampusIdTerms
Description	Clears the campus `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCampusQuery
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	getCampusQuery
Description	Gets the query for a campus query. Multiple retrievals produce a nested `OR` term.
Return	`osid.room.CampusQuery`		the campus query
Errors	UNIMPLEMENTED		`supportsCampusQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCampusQuery()` is `true.`
Method	clearCampusTerms
Description	Clears the campus terms.
Compliance	`mandatory`		This method must be implemented.
Method	getBuildingQueryRecord
Description	Gets the building query record corresponding to the given `Building` record `Type.` Multiple record retrievals produce a nested boolean `OR` term.
Parameters	`osid.type.Type`	`buildingRecordType`	a building record type
Return	`osid.room.records.BuildingQueryRecord`		the building query record
Errors	NULL_ARGUMENT		`buildingRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(buildingRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.