Interface AssessmentPartQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
AssessmentPartSearchSession
public interface AssessmentPartQuerySession extends OsidSession

This session provides methods for searching among AssessmentPart objects. The search query is constructed using the AssessmentPartQuery .

This session defines views that offer differing behaviors for searching.

  • federated bank view: searches include assessment parts in bank of which this bank is an ancestor in the bank hierarchy
  • isolated bank view: searches are restricted to assessment parts in this bank
  • sequestered assessment part viiew: All assessment part methods suppress sequestered assessment parts.
  • unsequestered assessment part view: All assessment part methods return all assessment parts.

Assessment parts may have a query record indicated by their respective record types. The query record is accessed via the AssessmentPartQuery .

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

    • canSearchAssessmentParts

      boolean canSearchAssessmentParts()
      Tests if this user can perform AssessmentPart lookups. 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 offer lookup 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 assessment part in banks which are children of this step 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 lookups to this bank only.
      Compliance:
      mandatory - This method is must be implemented.

    • useSequesteredAssessmentPartView

      void useSequesteredAssessmentPartView()
      The methods in this session omit sequestered assessment parts.
      Compliance:
      mandatory - This method is must be implemented.

    • useUnsequesteredAssessmentPartView

      void useUnsequesteredAssessmentPartView()
      The methods in this session return all assessment parts, including sequestered assessment parts.
      Compliance:
      mandatory - This method is must be implemented.

    • getAssessmentPartQuery

      AssessmentPartQuery getAssessmentPartQuery()
      Gets an assessment part query.
      Returns:
      the assessment part query
      Compliance:
      mandatory - This method must be implemented.

    • getAssessmentPartsByQuery

      AssessmentPartList getAssessmentPartsByQuery(AssessmentPartQuery assessmentPartQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of AssessmentParts matching the given assessment part query.
      Parameters:
      assessmentPartQuery - the assessment part query
      Returns:
      the returned AssessmentPartList
      Throws:
      NullArgumentException - assessmentPartQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - assessmentPartQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.