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

Interface	osid.room.squatting.DeedQuery
Implements	`osid.OsidRelationshipQuery`
Used By	`osid.room.squatting.DeedQuerySession`
	`osid.room.squatting.DeedSearchSession`
	`osid.room.squatting.DeedSmartCampusSession`
Description	This is the query for searching for deeds. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchBuildingId
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		`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	clearBuildingTerms
Description	Clears the building terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchOwnerId
Description	Sets a resource `Id`.
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	clearOwnerIdTerms
Description	Clears the owner resource `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsOwnerQuery
Description	Tests if a `ResourceQuery` is available.
Return	`boolean`		`true` if a resource query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getOwnerQuery
Description	Gets the query for an owner resource query. Multiple retrievals produce a nested `OR` term.
Return	`osid.resource.ResourceQuery`		the resource query
Errors	UNIMPLEMENTED		`supportsOwnerQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsOwnerQuery()` is `true`.
Method	clearOwnerTerms
Description	Clears the owner terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCampusId
Description	Sets the deed `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	getDeedQueryRecord
Description	Gets the deed query record corresponding to the given `Deed` record `Type`.Multiple record retrievals produce a nested boolean `OR` term.
Parameters	`osid.type.Type`	`deedRecordType`	a deed record type
Return	`osid.room.squatting.records.DeedQueryRecord`		the deed query record
Errors	NULL_ARGUMENT		`deedRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(deedRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.