Interface AssessmentPartLookupSession

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

This session defines methods for retrieving assessment parts.

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 bank view: All assessment part methods in this session operate, retrieve and pertain to assessment parts defined explicitly in the current bank.
  • federated bank view: All assessment part lookup methods in this session operate, retrieve and pertain to all assessment part defined in this bank and any other assessment parts implicitly available in this bank through bank inheritence.
  • active assessment part view: All assessment part lookup methods return active assessment parts.
  • any status assessment part view: Assessment parts of any active or inactive status are returned from methods.
  • sequestered assessment part viiew: All assessment part methods suppress sequestered assessment parts.
  • unsequestered assessment part view: All assessment part methods return all assessment parts.

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

Assessment parts may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the AssessmentPart .

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

    • canLookupAssessmentParts

      boolean canLookupAssessmentParts()
      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 lookup methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeAssessmentPartView

      void useComparativeAssessmentPartView()
      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.

    • usePlenaryAssessmentPartView

      void usePlenaryAssessmentPartView()
      A complete view of the AssessmentPart 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.

    • useActiveAssessmentPartView

      void useActiveAssessmentPartView()
      Only active assessment parts are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • useAnyStatusAssessmentPartView

      void useAnyStatusAssessmentPartView()
      All active and inactive assessment parts are returned by methods in this session.
      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.

    • getAssessmentPart

      AssessmentPart getAssessmentPart(Id assessmentPartId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the AssessmentPart specified by its Id . In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned AssessmentPart may have a different Id than requested, such as the case where a duplicate Id was assigned to an AssessmentPart and retained for compatibility. In active mode, assessment parts are returned that are currently active. In any effective mode, active and inactive assessment parts are returned. In sequestered mode, no sequestered assessment parts are returned. In unsequestered mode, all assessment parts are returned.
      Parameters:
      assessmentPartId - the Id of the AssessmentPart to retrieve
      Returns:
      the returned AssessmentPart
      Throws:
      NotFoundException - no AssessmentPart found with the given Id
      NullArgumentException - assessmentPartId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAssessmentPartsByIds

      AssessmentPartList getAssessmentPartsByIds(IdList assessmentPartIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets an AssessmentPartList corresponding to the given IdList . In plenary mode, the returned list contains all of the assessment parts specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible AssessmentParts may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, assessment parts are returned that are currently active. In any effective mode, active and inactive assessment parts are returned. In sequestered mode, no sequestered assessment parts are returned. In unsequestered mode, all assessment parts are returned.
      Parameters:
      assessmentPartIds - the list of Ids to retrieve
      Returns:
      the returned AssessmentPart list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - assessmentPartIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAssessmentPartsByGenusType

      AssessmentPartList getAssessmentPartsByGenusType(Type assessmentPartGenusType) throws OperationFailedException, PermissionDeniedException
      Gets an AssessmentPartList corresponding to the given assessment part genus Type which does not include assessment parts of types derived from the specified Type . 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. In active mode, assessment parts are returned that are currently active. In any effective mode, active and inactive assessment parts are returned. In sequestered mode, no sequestered assessment parts are returned. In unsequestered mode, all assessment parts are returned.
      Parameters:
      assessmentPartGenusType - an assessment part genus type
      Returns:
      the returned AssessmentPart list
      Throws:
      NullArgumentException - assessmentPartGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAssessmentPartsByParentGenusType

      AssessmentPartList getAssessmentPartsByParentGenusType(Type assessmentGenusType) throws OperationFailedException, PermissionDeniedException
      Gets an AssessmentPartList corresponding to the given assessment part genus Type and include any additional assessment parts with genus types derived from the specified Type . 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. In active mode, assessment parts are returned that are currently active. In any effective mode, active and inactive assessment parts are returned. In sequestered mode, no sequestered assessment parts are returned. In unsequestered mode, all assessment parts are returned.
      Parameters:
      assessmentGenusType - an assessment part genus type
      Returns:
      the returned AssessmentPart list
      Throws:
      NullArgumentException - assessmentPartGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAssessmentPartsByRecordType

      AssessmentPartList getAssessmentPartsByRecordType(Type assessmentPartRecordType) throws OperationFailedException, PermissionDeniedException
      Gets an AssessmentPart containing the given assessment part record Type . 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. In active mode, assessment parts are returned that are currently active. In any effective mode, active and inactive assessment parts are returned. In sequestered mode, no sequestered assessment parts are returned. In unsequestered mode, all assessment parts are returned.
      Parameters:
      assessmentPartRecordType - an assessment part record type
      Returns:
      the returned AssessmentPart list
      Throws:
      NullArgumentException - assessmentPartRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAssessmentPartsForAssessment

      AssessmentPartList getAssessmentPartsForAssessment(Id assessmentId) throws OperationFailedException, PermissionDeniedException
      Gets an AssessmentPart for the given assessment. 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. In active mode, assessment parts are returned that are currently active. In any effective mode, active and inactive assessment parts are returned. In sequestered mode, no sequestered assessment parts are returned. In unsequestered mode, all assessment parts are returned.
      Parameters:
      assessmentId - an assessment Id
      Returns:
      the returned AssessmentPart list
      Throws:
      NullArgumentException - assessmentId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAssessmentParts

      AssessmentPartList getAssessmentParts() throws OperationFailedException, PermissionDeniedException
      Gets all AssessmentParts . 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. In active mode, assessment parts are returned that are currently active. In any effective mode, active and inactive assessment parts are returned. In sequestered mode, no sequestered assessment parts are returned. In unsequestered mode, all assessment parts are returned.
      Returns:
      a list of AssessmentParts
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.