Interface AcademyQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
AcademySearchSession
public interface AcademyQuerySession extends OsidSession

This session provides methods for searching Academy objects. The search query is constructed using the AcademyQuery. The academy record Type also specifies the record for the academy query.

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

Like all OsidSessions, AcademyQuerySessions are dedicated to single processing threads and a single authenticated user.

  • Method Details

    • canSearchAcademies

      boolean canSearchAcademies()
      Tests if this user can perform Academy 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 opt not to offer search operations to unauthorized users.
      Returns:
      false if search methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getAcademyQuery

      AcademyQuery getAcademyQuery()
      Gets an academy query.
      Returns:
      the academy query
      Compliance:
      mandatory - This method must be implemented.

    • getAcademiesByQuery

      AcademyList getAcademiesByQuery(AcademyQuery academyQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of Academies matching the given search.
      Parameters:
      academyQuery - the academy query
      Returns:
      the returned AcademyList
      Throws:
      NullArgumentException - academyQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - academyQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.