Interface | osid.room.RoomSmartCampusSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages queries and sequencing to create
"smart" dynamic catalogs. A This | ||
Method | getCampusId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Campus Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getCampus | ||
Description |
Gets the | ||
Return | osid.room.Campus | the Campus associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
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 | ||
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 | |
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 | |
UNSUPPORTED | roomQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |