Interface RenovationSmartCampusSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. A RenovationQuery can be retrieved from this session and mapped to this Campus to create a virtual collection of Renovations . The renovations may be sequenced using the RenovationSearchOrder from this session.

This Campus has a default query that matches any renovation and a default search order that specifies no sequencing. The queries may be examined using a RenovationQueryInspector . The query may be modified by converting the inspector back to a RenovationQuery .

  • 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.

    • getRenovationQuery

      RenovationQuery getRenovationQuery()
      Gets a renovation query.
      Returns:
      the renovation query
      Compliance:
      mandatory - This method must be implemented.

    • getRenovationSearchOrder

      RenovationSearchOrder getRenovationSearchOrder()
      Gets a renovation search order.
      Returns:
      the renovation search order
      Compliance:
      mandatory - This method must be implemented.

    • applyRenovationQuery

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

    • inspectRenovationQuery

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

    • applyRenovationSequencing

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

    • getRenovationQueryFromInspector

      RenovationQuery getRenovationQueryFromInspector(RenovationQueryInspector renovationQueryInspector)
      Gets a renovation query from an inspector.
      Parameters:
      renovationQueryInspector - a query inspector
      Returns:
      the renovation query
      Throws:
      NullArgumentException - renovationQueryInspector is null
      UnsupportedException - renovationQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.