Interface ConferralSmartAcademySession

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

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

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

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

    • getConferralQuery

      ConferralQuery getConferralQuery()
      Gets a conferral query.
      Returns:
      the conferral query
      Compliance:
      mandatory - This method must be implemented.

    • getConferralSearchOrder

      ConferralSearchOrder getConferralSearchOrder()
      Gets a conferral search order.
      Returns:
      the conferral search order
      Compliance:
      mandatory - This method must be implemented.

    • applyConferralQuery

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

    • inspectConferralQuery

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

    • applyConferralSequencing

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

    • getConferralQueryFromInspector

      ConferralQuery getConferralQueryFromInspector(ConferralQueryInspector conferralQueryInspector)
      Gets a conferral query from an inspector.
      Parameters:
      conferralQueryInspector - a query inspector
      Returns:
      the conferral query
      Throws:
      NullArgumentException - conferralQueryInspector is null
      UnsupportedException - conferralQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.