Interface ItemLookupSession

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

This session provides methods for retrieving Item objects.

This session defines two sets of views which offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete and ordered result set or is an error condition
  • isolated assessment bank view: All assessment item methods in this session operate, retrieve and pertain to assessment items defined explicitly in the current bank. Using an isolated view is useful for managing items with the ItemAdminSession .
  • federated assessment bank view: All assessment item methods in this session operate, retrieve and pertain to all assessment items defined in this assessment bank and any other assessment banks implicitly available in this assessment bank through assessment bank inheritence.

Generally, the comparative view should be used for most applications as it permits operation even if there a particular element is inaccessible. For example, a hierarchy output can be plugged into a lookup method to retrieve all objects known to a hierarchy, but it may not be necessary to break execution if a node from the hierarchy no longer exists. However, some administrative applications may need to know whether it had retrieved an entire set of objects and may sacrifice some interoperability for the sake of precision.

Items may have an additional records indicated by their respective record types.

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

    • canLookupItems

      boolean canLookupItems()
      Tests if this user can perform Item 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.
      Returns:
      false if lookup methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeItemView

      void useComparativeItemView()
      The returns from the lookup methods may omit or translate elements based on this session, such as assessment, 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.

    • usePlenaryItemView

      void usePlenaryItemView()
      A complete view of the Item 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 items in assessment banks which are children of this assessment bank in the assessment 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 assessment bank only.
      Compliance:
      mandatory - This method is must be implemented.

    • getItem

      Item getItem(Id itemId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Item specified by its Id . In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Item may have a different Id than requested, such as the case where a duplicate Id was assigned to an Item and retained for compatibility.
      Parameters:
      itemId - the Id of the Item to retrieve
      Returns:
      the returned Item
      Throws:
      NotFoundException - no Item found with the given Id
      NullArgumentException - itemId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • getItemsByIds

      ItemList getItemsByIds(IdList itemIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets an ItemList corresponding to the given IdList . In plenary mode, the returned list contains all of the items 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 Items may be omitted from the list and may present the elements in any order including returning a unique set.
      Parameters:
      itemIds - the list of Ids to retrieve
      Returns:
      the returned Item list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - itemIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • getItemsByGenusType

      ItemList getItemsByGenusType(Type itemGenusType) throws OperationFailedException, PermissionDeniedException
      Gets an ItemList corresponding to the given assessment item genus Type which does not include assessment items of genus types derived from the specified Type .In plenary mode, the returned list contains all known assessment items or an error results. Otherwise, the returned list may contain only those assessment items that are accessible through this session.
      Parameters:
      itemGenusType - an assessment item genus type
      Returns:
      the returned Item list
      Throws:
      NullArgumentException - itemGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • getItemsByParentGenusType

      ItemList getItemsByParentGenusType(Type itemGenusType) throws OperationFailedException, PermissionDeniedException
      Gets an ItemList corresponding to the given assessment item genus Type and include any additional assessment items with genus types derived from the specified Type . In plenary mode, the returned list contains all known assessment items or an error results. Otherwise, the returned list may contain only those assessment items that are accessible through this session.
      Parameters:
      itemGenusType - an assessment item genus type
      Returns:
      the returned Item list
      Throws:
      NullArgumentException - itemGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • getItemsByRecordType

      ItemList getItemsByRecordType(Type itemRecordType) throws OperationFailedException, PermissionDeniedException
      Gets an ItemList containing the given assessment item record Type .In plenary mode, the returned list contains all known items or an error results. Otherwise, the returned list may contain only those assessment items that are accessible through this session.
      Parameters:
      itemRecordType - an item record type
      Returns:
      the returned Item list
      Throws:
      NullArgumentException - itemRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • getItemsByQuestion

      ItemList getItemsByQuestion(Id questionId) throws OperationFailedException, PermissionDeniedException
      Gets an ItemList containing the given question. In plenary mode, the returned list contains all known items or an error results. Otherwise, the returned list may contain only those assessment items that are accessible through this session.
      Parameters:
      questionId - a question Id
      Returns:
      the returned Item list
      Throws:
      NullArgumentException - questionId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • getItemsByAnswer

      ItemList getItemsByAnswer(Id answerId) throws OperationFailedException, PermissionDeniedException
      Gets an ItemList containing the given answer. In plenary mode, the returned list contains all known items or an error results. Otherwise, the returned list may contain only those assessment items that are accessible through this session.
      Parameters:
      answerId - an answer Id
      Returns:
      the returned Item list
      Throws:
      NullArgumentException - answerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • getItemsByLearningObjective

      ItemList getItemsByLearningObjective(Id objectiveId) throws OperationFailedException, PermissionDeniedException
      Gets an ItemList containing the given learning objective. In plenary mode, the returned list contains all known items or an error results. Otherwise, the returned list may contain only those assessment items that are accessible through this session.
      Parameters:
      objectiveId - a learning objective Id
      Returns:
      the returned Item list
      Throws:
      NullArgumentException - objectiveId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • getItemsByLearningObjectives

      ItemList getItemsByLearningObjectives(IdList objectiveIds) throws OperationFailedException, PermissionDeniedException
      Gets an ItemList containing the given learning objectives. In plenary mode, the returned list contains all known items or an error results. Otherwise, the returned list may contain only those assessment items that are accessible through this session.
      Parameters:
      objectiveIds - a list of learning objective Ids
      Returns:
      the returned Item list
      Throws:
      NullArgumentException - objectiveIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • getItems

      ItemList getItems() throws OperationFailedException, PermissionDeniedException
      Gets all Items . 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.
      Returns:
      a list of Items
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.