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

Interface	osid.room.construction.ProjectSmartCampusSession
Implements	`osid.OsidSession`
Used By	`osid.room.construction.RoomConstructionManager`
Used By	`osid.room.construction.RoomConstructionProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `ProjectQuery` can be retrieved from this session and mapped to this `Campus` to create a virtual collection of `Projects`. The projects may be sequenced using the `ProjectSearchOrder` from this session. This `Campus` has a default query that matches any project and a default search order that specifies no sequencing. The queries may be examined using a `ProjectQueryInspector`. The query may be modified by converting the inspector back to a `ProjectQuery`.
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	getProjectQuery
Description	Gets a project query.
Return	`osid.room.construction.ProjectQuery`		the project query
Compliance	`mandatory`		This method must be implemented.
Method	getProjectSearchOrder
Description	Gets a project search order.
Return	`osid.room.construction.ProjectSearchOrder`		the project search order
Compliance	`mandatory`		This method must be implemented.
Method	applyProjectQuery
Description	Applies a project query to this campus.
Parameters	`osid.room.construction.ProjectQuery`	`projectQuery`	the project query
Errors	NULL_ARGUMENT		`projectQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`projectQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectProjectQuery
Description	Gets a project query inspector for this campus.
Return	`osid.room.construction.ProjectQueryInspector`		the project query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyProjectSequencing
Description	Applies a project search order to this campus.
Parameters	`osid.room.construction.ProjectSearchOrder`	`projectSearchOrder`	the project search order
Errors	NULL_ARGUMENT		`projectSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`projectSearchOrder` did not originate from `getProjectSearchOrder()`
Compliance	`mandatory`		This method must be implemented.
Method	getProjectQueryFromInspector
Description	Gets a project query from an inspector.
Parameters	`osid.room.construction.ProjectQueryInspector`	`projectQueryInspector`	a query inspector
Return	`osid.room.construction.ProjectQuery`		the project query
Errors	NULL_ARGUMENT		`projectQueryInspector` is `null`
Errors	UNSUPPORTED		`projectQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.