Interface ConvocationQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
ConvocationSearchSession
public interface ConvocationQuerySession extends OsidSession

This session provides methods for searching Convocations. The search query is constructed using the ConvocationQuery. The award record Type also specifies the record for the award query.

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

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

    • canSearchConvocations

      boolean canSearchConvocations()
      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.

    • useFederatedAcademyView

      void useFederatedAcademyView()
      Federates the view for methods in this session. A federated view will include convocations in academies which are children of this academy in the academy hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedAcademyView

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

    • getConvocationQuery

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

    • getConvocationsByQuery

      ConvocationList getConvocationsByQuery(ConvocationQuery convocationQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of convocations matching the given convocation query.
      Parameters:
      convocationQuery - the convocation query
      Returns:
      the returned ConvocationList
      Throws:
      NullArgumentException - convocationQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - convocationQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.