Interface RoomSmartCampusSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface RoomSmartCampusSession extends OsidSession

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.

Like all OsidSessions, RoomSmartCampusSessions are dedicated to single processing threads and a single authenticated user.

  • Method Details

    • getCampusId

      Id getCampusId()
      Gets the Campus Id associated with this session.
      Returns:
      the Campus Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getCampus

      Campus getCampus() throws OperationFailedException, PermissionDeniedException
      Gets the Campus associated with this session.
      Returns:
      the Campus associated with this session
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canManageSmartCampuses

      boolean canManageSmartCampuses()
      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.
      Returns:
      false if smart campus management is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getRoomQuery

      RoomQuery getRoomQuery()
      Gets a room query.
      Returns:
      the room query
      Compliance:
      mandatory - This method must be implemented.

    • getRoomSearchOrder

      RoomSearchOrder getRoomSearchOrder()
      Gets a room search order.
      Returns:
      the room search order
      Compliance:
      mandatory - This method must be implemented.

    • applyRoomQuery

      void applyRoomQuery(RoomQuery roomQuery) throws OperationFailedException, PermissionDeniedException
      Applies a room query to this campus.
      Parameters:
      roomQuery - the room query
      Throws:
      NullArgumentException - roomQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - roomQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspectRoomQuery

      RoomQueryInspector inspectRoomQuery() throws OperationFailedException, PermissionDeniedException
      Gets a room query inspector for this campus.
      Returns:
      the rooms query inspector
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • applyRoomSequencing

      void applyRoomSequencing(RoomSearchOrder roomSearchOrder) throws OperationFailedException, PermissionDeniedException
      Applies a room search order to this campus.
      Parameters:
      roomSearchOrder - the room search order
      Throws:
      NullArgumentException - roomSearchOrder is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - roomSearchOrder not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getRoomQueryFromInspector

      RoomQuery getRoomQueryFromInspector(RoomQueryInspector roomQueryInspector)
      Gets a room query from an inspector.
      Parameters:
      roomQueryInspector - a query inspector
      Returns:
      the room query
      Throws:
      NullArgumentException - roomQueryInspector is null
      UnsupportedException - roomQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.