Interface RoomQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
RoomSearchSession
public interface RoomQuerySession extends OsidSession

This session provides methods for searching Rooms. The search query is constructed using the RoomQuery. The building record Type also specifies the record for the building query.

Rooms may have a query record indicated by their respective record types. The query record is accessed via the RoomQuery. The returns in this session may not be cast directly to these interfaces.

  • 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
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canSearchRooms

      boolean canSearchRooms()
      Tests if this user can perform susbcription searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not wish to offer search operations to unauthorized users.
      Returns:
      false if search methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useFederatedCampusView

      void useFederatedCampusView()
      Federates the view for methods in this session. A federated view will include entries in campuses which are children of this campus in the campus hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedCampusView

      void useIsolatedCampusView()
      Isolates the view for methods in this session. An isolated view restricts retrievals to this campus only.
      Compliance:
      mandatory - This method is must be implemented.

    • getRoomQuery

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

    • getRoomsByQuery

      RoomList getRoomsByQuery(RoomQuery roomQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of rooms matching the given room query.
      Parameters:
      roomQuery - the room query
      Returns:
      the returned RoomList
      Throws:
      NullArgumentException - roomQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - roomQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.