Interface OrderItemLookupSession

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

This session provides methods for retrieving OrderItem objects.

This session defines views that offer differing behaviors when retrieving multiple objects.

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

Like all OsidSessions, OrderItemLookupSessions are dedicated to single processing threads and a single authenticated user.

  • Method Details

    • getStoreId

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

    • getStore

      Store getStore() throws OperationFailedException, PermissionDeniedException
      Gets the Store associated with this session.
      Returns:
      the store
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canLookupOrderItems

      boolean canLookupOrderItems()
      Tests if this user can perform OrderItem 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.

    • useComparativeOrderItemView

      void useComparativeOrderItemView()
      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 must be implemented.

    • usePlenaryOrderItemView

      void usePlenaryOrderItemView()
      A complete view of the OrderItem 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 must be implemented.

    • useFederatedStoreView

      void useFederatedStoreView()
      Federates the view for methods in this session. A federated view will include order items in stores which are children of this store in the store hierarchy.
      Compliance:
      mandatory - This method must be implemented.

    • useIsolatedStoreView

      void useIsolatedStoreView()
      Isolates the view for methods in this session. An isolated view restricts retrievals to this store only.
      Compliance:
      mandatory - This method must be implemented.

    • getOrderItem

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

    • getOrderItemsByIds

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

    • getOrderItemsByGenusType

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

    • getOrderItemsByParentGenusType

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

    • getOrderItemsByRecordType

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

    • getOrderItemsForOrder

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

    • getOrderItems

      OrderItemList getOrderItems() throws OperationFailedException, PermissionDeniedException
      Gets all OrderItems. In plenary mode, the returned list contains all known order items or an error results. Otherwise, the returned list may contain only those order items that are accessible through this session.
      Returns:
      a list of OrderItems
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.