OSID - osid.room.squatting.LeaseQuery Service Interface Definition

Interface	osid.room.squatting.LeaseQuery
Implements	`osid.OsidRelationshipQuery`
Description	This is the query for searching for leases. 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 leases.
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 lease.
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	matchTenantId
Description	Sets the resource `Id` for this query to match rooms assigned to leases.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`resourceId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearTenantIdTerms
Description	Clears the tenant `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsTenantQuery
Description	Tests if a tenant query is available.
Return	`boolean`		`true` if a tenant query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getTenantQuery
Description	Gets the query for a tenant resource.
Return	`osid.resource.ResourceQuery`		the resource query
Errors	UNIMPLEMENTED		`supportsTenantQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsTenantQuery()` is `true.`
Method	clearTenantTerms
Description	Clears the tenant terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCampusId
Description	Sets the lease `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	getLeaseQueryRecord
Description	Gets the lease query record corresponding to the given `Lease` record `Type.` Multiple record retrievals produce a nested boolean `OR` term.
Parameters	`osid.type.Type`	`leaseRecordType`	a lease record type
Return	`osid.room.squatting.records.LeaseQueryRecord`		the lease query record
Errors	NULL_ARGUMENT		`leaseRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(leaseRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.