Interface ConvocationSmartAcademySession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. A ConvocationQuery can be retrieved from this session and mapped to this Academy to create a virtual collection of Convocations . The awards may be sequenced using the ConvocationSearchOrder from this session.

This Academy has a default query that matches any convocation and a default search order that specifies no sequencing. The queries may be examined using a ConvocationQueryInspector . The query may be modified by converting the inspector back to a ConvocationQuery .

  • Method Details

    • getAcademyId

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

    • getAcademy

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

    • canManageSmartAcademies

      boolean canManageSmartAcademies()
      Tests if this user can manage smart academies. 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 academy management is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getConvocationQuery

      ConvocationQuery getConvocationQuery()
      Gets a convocation query.
      Returns:
      the convocation query
      Compliance:
      mandatory - This method must be implemented.

    • getConvocationSearchOrder

      ConvocationSearchOrder getConvocationSearchOrder()
      Gets a convocation search order.
      Returns:
      the convocation search order
      Compliance:
      mandatory - This method must be implemented.

    • applyConvocationQuery

      void applyConvocationQuery(ConvocationQuery convocationQuery) throws OperationFailedException, PermissionDeniedException
      Applies a convocation query to this academy.
      Parameters:
      convocationQuery - the convocation query
      Throws:
      NullArgumentException - convocationQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - convocationQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspectConvocationQuery

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

    • applyConvocationSequencing

      void applyConvocationSequencing(ConvocationSearchOrder convocationSearchOrder) throws OperationFailedException, PermissionDeniedException
      Applies a convocation search order to this academy.
      Parameters:
      convocationSearchOrder - the convocation search order
      Throws:
      NullArgumentException - convocationSearchOrder is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - convocationSearchOrder not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getConvocationQueryFromInspector

      ConvocationQuery getConvocationQueryFromInspector(ConvocationQueryInspector convocationQueryInspector)
      Gets a convocation query from an inspector.
      Parameters:
      convocationQueryInspector - a query inspector
      Returns:
      the convocation query
      Throws:
      NullArgumentException - convocationQueryInspector is null
      UnsupportedException - convocationQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.