Interface ItemLookupSession

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

This session defines methods for retrieving items. An Item is a scheduled course listed in a warehouse. An Item is derived from a Course and maps to an offering time and registered students.

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 warehouse view: All item methods in this session operate, retrieve and pertain to items defined explicitly in the current warehouse. Using an isolated view is useful for managing Items with the ItemAdminSession .
  • federated warehouse view: All item lookup methods in this session operate, retrieve and pertain to all items defined in this warehouse and any other itemss implicitly available in this warehouse through warehouse inheritence.

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

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

  • Method Details

    • getWarehouseId

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

    • getWarehouse

      Warehouse getWarehouse() throws OperationFailedException, PermissionDeniedException
      Gets the Warehouse associated with this session.
      Returns:
      the warehouse
      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 not offer lookup operations to unauthorized users.
      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 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.

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

    • useFederatedWarehouseView

      void useFederatedWarehouseView()
      Federates the view for methods in this session. A federated view will include items in catalogs which are children of this catalog in the warehouse hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedWarehouseView

      void useIsolatedWarehouseView()
      Isolates the view for methods in this session. An isolated view restricts retrievals to this warehouse 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
      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
      Compliance:
      mandatory - This method must be implemented.

    • getItemsByGenusType

      ItemList getItemsByGenusType(Type itemGenusType) throws OperationFailedException, PermissionDeniedException
      Gets an ItemList corresponding to the given item genus Type which does not include items of types derived from the specified Type . 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:
      itemGenusType - an item genus type
      Returns:
      the returned Item list
      Throws:
      NullArgumentException - itemGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getItemsByParentGenusType

      ItemList getItemsByParentGenusType(Type itemGenusType) throws OperationFailedException, PermissionDeniedException
      Gets an ItemList corresponding to the given item genus Type and include any additional items with genus types derived from the specified Type . 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:
      itemGenusType - an item genus type
      Returns:
      the returned Item list
      Throws:
      NullArgumentException - itemGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getItemsByRecordType

      ItemList getItemsByRecordType(Type itemRecordType) throws OperationFailedException, PermissionDeniedException
      Gets an ItemList containing the given 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 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
      Compliance:
      mandatory - This method must be implemented.

    • getItemsByStock

      ItemList getItemsByStock(Id stockId) throws OperationFailedException, PermissionDeniedException
      Gets an ItemList for the given stock. 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:
      stockId - a stock Id
      Returns:
      the returned Item list
      Throws:
      NullArgumentException - stockId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getItemsByPropertyTag

      ItemList getItemsByPropertyTag(String property) throws OperationFailedException, PermissionDeniedException
      Gets an ItemList for the given property tag. 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:
      property - a property number
      Returns:
      the returned Item list
      Throws:
      NullArgumentException - property is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getItemsBySerialNumber

      ItemList getItemsBySerialNumber(String serialNumber) throws OperationFailedException, PermissionDeniedException
      Gets an ItemList for the given serial number. 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:
      serialNumber - a serial number
      Returns:
      the returned Item list
      Throws:
      NullArgumentException - serialNumber is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getItemParts

      ItemList getItemParts(Id itemId) throws OperationFailedException, PermissionDeniedException
      Gets an ItemList immediately contained within the given item. 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:
      itemId - an item Id
      Returns:
      the returned Item list
      Throws:
      NullArgumentException - itemId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      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
      Compliance:
      mandatory - This method must be implemented.