Interface AssessmentOfferedQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
AssessmentOfferedSearchSession
public interface AssessmentOfferedQuerySession extends OsidSession

This session provides methods for querying AssessmentOffered objects. The search query is constructed using the AssessmentOfferedQuery.

This session defines views that offer differing behaviors for searching.

  • federated bank view: searches include assessments offered in banks of which this bank is a ancestor in the bank hierarchy
  • isolated bank view: searches are restricted to assessments offered in this bank

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

  • Method Details

    • getBankId

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

    • getBank

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

    • canSearchAssessmentsOffered

      boolean canSearchAssessmentsOffered()
      Tests if this user can perform AssessmentOffered 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 wish 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.

    • useFederatedBankView

      void useFederatedBankView()
      Federates the view for methods in this session. A federated view will include assessments offered in banks which are children of this bank in the bank hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedBankView

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

    • getAssessmentOfferedQuery

      AssessmentOfferedQuery getAssessmentOfferedQuery()
      Gets an assessment offered query.
      Returns:
      the assessment offered query
      Compliance:
      mandatory - This method must be implemented.

    • getAssessmentsOfferedByQuery

      AssessmentOfferedList getAssessmentsOfferedByQuery(AssessmentOfferedQuery assessmentOfferedQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of AssessmentOffered elements matching the given assessment offered query.
      Parameters:
      assessmentOfferedQuery - the assessment offered query
      Returns:
      the returned AssessmentOfferedList
      Throws:
      NullArgumentException - assessmentOfferedQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - assessmentOfferedQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.