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

Interface	osid.room.squatting.DeedQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.room.squatting.DeedSearchSession`
Used By	`osid.room.squatting.RoomSquattingManager`
Used By	`osid.room.squatting.RoomSquattingProxyManager`
Description	This session provides methods for searching `Deeds`. The search query is constructed using the `DeedQuery`. The deed record `Type` also specifies the record for the deed query. Deeds may have a query record indicated by their respective record types. The query record is accessed via the `DeedQuery`. The returns in this session may not be cast directly to these interfaces.
Method	getCampusId
Description	Gets the `Campus` `Id` associated with this session.
Return	`osid.id.Id`		the `Campus Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCampus
Description	Gets the `Campus` associated with this session.
Return	`osid.room.Campus`		the campus
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSearchDeeds
Description	Tests if this user can perform `Deed` searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer search operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedCampusView
Description	Federates the view for methods in this session. A federated view will include deeds in campuses which are children of this campus in the campus hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedCampusView
Description	Isolates the view for methods in this session. An isolated view restricts retrievals to this campus only.
Compliance	`mandatory`		This method is must be implemented.
Method	getDeedQuery
Description	Gets a deed query.
Return	`osid.room.squatting.DeedQuery`		the deed query
Compliance	`mandatory`		This method must be implemented.
Method	getDeedsByQuery
Description	Gets a list of `Deeds` matching the given deed query.
Parameters	`osid.room.squatting.DeedQuery`	`deedQuery`	the deed query
Return	`osid.room.squatting.DeedList`		the returned `DeedList`
Errors	NULL_ARGUMENT		`deedQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`DeedQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.