Interface AssessmentPartItemSession

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

This session defines methods for looking up Item to AssessmentPart mappings.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
  • isolated assessment part view: only items in the specified assessment part are accessible
  • federated assessment part view: includes items in assessment parts that are descendants of the specified assessment part

The methods useFederatedAssessmentPartView() and useIsolatedAssessmentPartView() behave as a radio group and one should be selected before invoking any lookup methods.

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

    • canAccessAssessmentPartItems

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

    • useComparativeAsseessmentPartItemView

      void useComparativeAsseessmentPartItemView()
      The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
      Compliance:
      mandatory - This method is must be implemented.

    • usePlenaryAssessmentPartItemView

      void usePlenaryAssessmentPartItemView()
      A complete view of the returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
      Compliance:
      mandatory - This method is must be implemented.

    • useFederatedBankView

      void useFederatedBankView()
      Federates the view for methods in this session. A federated view will include assessment parts in catalogs which are children of this catalog 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 retrievals to this bank only.
      Compliance:
      mandatory - This method is must be implemented.

    • getAssessmentPartItems

      ItemList getAssessmentPartItems(Id assessmentPartId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of items mapped to the given AssessmentPart . In plenary mode, the returned list contains all known items or an error results. Otherwise, the returned list may contain only those items that are accessible through this session.
      Parameters:
      assessmentPartId - Id of the AssessmentPart
      Returns:
      list of items
      Throws:
      NotFoundException - assessmentPartId not found
      NullArgumentException - assessmentPartId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method is must be implemented.

    • getAssessmentPartsByItem

      AssessmentPartList getAssessmentPartsByItem(Id itemId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the assessment parts containing the given item. In plenary mode, the returned list contains all known assessment parts or an error results. Otherwise, the returned list may contain only those assessment parts that are accessible through this session.
      Parameters:
      itemId - Id of the Item
      Returns:
      the returned AssessmentPart list
      Throws:
      NotFoundException - itemId is not found
      NullArgumentException - itemId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.