OSID - osid.room.BuildingSmartCampusSession Service Interface Definition

Interface	osid.room.BuildingSmartCampusSession
Implements	`osid.OsidSession`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `BuildingQuery` can be retrieved from this session and mapped to this `Campus` to create a virtual collection of `Buildings.` The buildings may be sequenced using the `BuildingSearchOrder` from this session. This `Campus` has a default query that matches any building and a default search order that specifies no sequencing. The queries may be examined using a `BuildingQueryInspector.` The query may be modified by converting the inspector back to a `BuildingQuery.`
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	getBuildingQuery
Description	Gets a building query.
Return	`osid.room.BuildingQuery`		the building query
Compliance	`mandatory`		This method must be implemented.
Method	getBuildingSearchOrder
Description	Gets a building search order.
Return	`osid.room.BuildingSearchOrder`		the building search order
Compliance	`mandatory`		This method must be implemented.
Method	applyBuildingQuery
Description	Applies a building query to this campus.
Parameters	`osid.room.BuildingQuery`	`buildingQuery`	the building query
Errors	NULL_ARGUMENT		`buildingQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`buildingQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectBuildingQuery
Description	Gets a building query inspector for this campus.
Return	`osid.room.BuildingQueryInspector`		the building query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyBuildingSequencing
Description	Applies a building search order to this campus.
Parameters	`osid.room.BuildingSearchOrder`	`buildingSearchOrder`	the building search order
Errors	NULL_ARGUMENT		`buildingSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`buildingSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getBuildingQueryFromInspector
Description	Gets a building query from an inspector.
Parameters	`osid.room.BuildingQueryInspector`	`buildingQueryInspector`	a query inspector
Return	`osid.room.BuildingQuery`		the building query
Errors	NULL_ARGUMENT		`buildingQueryInspector` is `null`
Errors	UNSUPPORTED		`buildingQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.