OSID - osid.room.RoomSmartCampusSession Service Interface Definition

Interface	osid.room.RoomSmartCampusSession
Implements	`osid.OsidSession`
Used By	`osid.room.RoomManager`
Used By	`osid.room.RoomProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `RoomQuery` can be retrieved from this session and mapped to this `Campus` to create a virtual collection of `Rooms` . The rooms may be sequenced using the `RoomSearchOrder` from this session. This `Campus` has a default query that matches any room and a default search order that specifies no sequencing. The queries may be examined using a `RoomQueryInspector` . The query may be modified by converting the inspector back to a `RoomQuery` .
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	getRoomQuery
Description	Gets a room query.
Return	`osid.room.RoomQuery`		the room query
Compliance	`mandatory`		This method must be implemented.
Method	getRoomSearchOrder
Description	Gets a room search order.
Return	`osid.room.RoomSearchOrder`		the room search order
Compliance	`mandatory`		This method must be implemented.
Method	applyRoomQuery
Description	Applies a room query to this campus.
Parameters	`osid.room.RoomQuery`	`roomQuery`	the room query
Errors	NULL_ARGUMENT		`roomQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`roomQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectRoomQuery
Description	Gets a room query inspector for this campus.
Return	`osid.room.RoomQueryInspector`		the rooms query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyRoomSequencing
Description	Applies a room search order to this campus.
Parameters	`osid.room.RoomSearchOrder`	`roomSearchOrder`	the room search order
Errors	NULL_ARGUMENT		`roomSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`roomSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getRoomQueryFromInspector
Description	Gets a room query from an inspector.
Parameters	`osid.room.RoomQueryInspector`	`roomQueryInspector`	a query inspector
Return	`osid.room.RoomQuery`		the room query
Errors	NULL_ARGUMENT		`roomQueryInspector` is `null`
Errors	UNSUPPORTED		`roomQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.