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

Interface	osid.room.squatting.DeedSmartCampusSession
Implements	`osid.OsidSession`
Used By	`osid.room.squatting.RoomSquattingManager`
Used By	`osid.room.squatting.RoomSquattingProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `DeedQuery` can be retrieved from this session and mapped to this `Campus` to create a virtual collection of `Deeds`. The deeds may be sequenced using the `DeedSearchOrder` from this session. This `Campus` has a default query that matches any deed and a default search order that specifies no sequencing. The queries may be examined using a `DeedQueryInspector`. The query may be modified by converting the inspector back to a `DeedQuery`.
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` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageSmartCampuses
Description	Tests if this user can manage smart campuses. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.
Return	`boolean`		`false` if smart campus management is not authorized, `true` otherwise
Compliance	`mandatory`		This method 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	getDeedSearchOrder
Description	Gets a deed search order.
Return	`osid.room.squatting.DeedSearchOrder`		the deed search order
Compliance	`mandatory`		This method must be implemented.
Method	applyDeedQuery
Description	Applies a deed query to this campus.
Parameters	`osid.room.squatting.DeedQuery`	`deedQuery`	the deed query
Errors	NULL_ARGUMENT		`deedQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`deedQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectDeedQuery
Description	Gets a deed query inspector for this campus.
Return	`osid.room.squatting.DeedQueryInspector`		the deed query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyDeedSequencing
Description	Applies a deed search order to this campus.
Parameters	`osid.room.squatting.DeedSearchOrder`	`deedSearchOrder`	the deed search order
Errors	NULL_ARGUMENT		`deedSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`deedSearchOrder` did not originate from `getDeedSearchOrder()`
Compliance	`mandatory`		This method must be implemented.
Method	getDeedQueryFromInspector
Description	Gets a deed query from an inspector.
Parameters	`osid.room.squatting.DeedQueryInspector`	`deedQueryInspector`	a query inspector
Return	`osid.room.squatting.DeedQuery`		the deed query
Errors	NULL_ARGUMENT		`deedQueryInspector` is `null`
Errors	UNSUPPORTED		`deedQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.