OSID - osid.room.FloorSmartCampusSession Service Interface Definition

Interface	osid.room.FloorSmartCampusSession
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 `FloorQuery` can be retrieved from this session and mapped to this `Campus` to create a virtual collection of `Floors` . The floors may be sequenced using the `FloorSearchOrder` from this session. This `Campus` has a default query that matches any floor and a default search order that specifies no sequencing. The queries may be examined using a `FloorQueryInspector` . The query may be modified by converting the inspector back to a `FloorQuery` .
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	getFloorQuery
Description	Gets a floor query.
Return	`osid.room.FloorQuery`		the floor query
Compliance	`mandatory`		This method must be implemented.
Method	getFloorSearchOrder
Description	Gets a floor search order.
Return	`osid.room.FloorSearchOrder`		the floor search order
Compliance	`mandatory`		This method must be implemented.
Method	applyFloorQuery
Description	Applies a floor query to this campus.
Parameters	`osid.room.FloorQuery`	`floorQuery`	the floor query
Errors	NULL_ARGUMENT		`floorQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`floorQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectFloorQuery
Description	Gets a floor query inspector for this campus.
Return	`osid.room.FloorQueryInspector`		the floor query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyFloorSequencing
Description	Applies a floor search order to this campus.
Parameters	`osid.room.FloorSearchOrder`	`floorSearchOrder`	the floor search order
Errors	NULL_ARGUMENT		`floorSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`floorSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getFloorQueryFromInspector
Description	Gets a floor query from an inspector.
Parameters	`osid.room.FloorQueryInspector`	`floorQueryInspector`	a query inspector
Return	`osid.room.FloorQuery`		the floor query
Errors	NULL_ARGUMENT		`floorQueryInspector` is `null`
Errors	UNSUPPORTED		`floorQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.