Interface ItemLookupSession

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

This session defines methods for retrieving items.

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

The methods useFederatedBusinessView() and useIsolatedBusinessView() 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

    • getBusinessId

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

    • getBusiness

      Business getBusiness() throws OperationFailedException, PermissionDeniedException
      Gets the Business associated with this session.
      Returns:
      the business
      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.

    • useFederatedBusinessView

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

    • useIsolatedBusinessView

      void useIsolatedBusinessView()
      Isolates the view for methods in this session. An isolated view restricts retrievals to this business 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 a 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.

    • getItemsByCategory

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

    • getItemsByAccount

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

    • getItemsByProduct

      ItemList getItemsByProduct(Id productId) throws OperationFailedException, PermissionDeniedException
      Gets an ItemList of the given product. 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:
      productId - a product Id
      Returns:
      the returned Item list
      Throws:
      NullArgumentException - productId 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.