OSID - osid.room.construction.RenovationQuery Service Interface Definition

Interface	osid.room.construction.RenovationQuery
Implements	`osid.OsidObjectQuery`
Implements	`osid.OsidTemporalQuery`
Used By	`osid.room.construction.RenovationQuerySession`
	`osid.room.construction.RenovationSearchSession`
	`osid.room.construction.RenovationSmartCampusSession`
Description	This is the query for searching for renovations. 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 renovations.
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 renovation.
Return	`osid.room.RoomQuery`		the room query
Errors	UNIMPLEMENTED		`supportsRoomQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRoomQuery()` is `true`.
Method	clearRoomTerms
Description	Clears the room terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCost
Description	Matches a cost within the given range inclusive.
Parameters	`osid.financials.Currency`	`low`	start of range
	`osid.financials.Currency`	`high`	end of range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`low` is greater than `high`
Errors	NULL_ARGUMENT		`low` or `high` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyCost
Description	Matches any cost.
Parameters	`boolean`	`match`	`true` to match projects with any cost assigned, `false` to match buildings with no cost assigned
Compliance	`mandatory`		This method must be implemented.
Method	clearCostTerms
Description	Clears the cost terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCampusId
Description	Sets the renovation `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	getRenovationQueryRecord
Description	Gets the renovation query record corresponding to the given `Renovation` record `Type`. Multiple record retrievals produce a nested boolean `OR` term.
Parameters	`osid.type.Type`	`renovationRecordType`	a renovation record type
Return	`osid.room.construction.records.RenovationQueryRecord`		the renovation query record
Errors	NULL_ARGUMENT		`renovationRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(renovationRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.