Interface ProductLookupSession

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

This session provides methods for retrieving Product 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 products defined explicitly in the current store. Using an isolated view is useful for managing products with the ProductAdminSession .
  • federated store view: All product lookup methods in this session operate, retrieve and pertain to all products defined in this store and any other stores implicitly available in this store through store inheritence.

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

    • canLookupProducts

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

    • useComparativeProductView

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

    • usePlenaryProductView

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

    • useFederatedStoreView

      void useFederatedStoreView()
      Federates the view for methods in this session. A federated view will include products in stores which are children of this store in the store hierarchy.
      Compliance:
      mandatory - This method is 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 is must be implemented.

    • getProduct

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

    • getProductsByIds

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

    • getProductsByGenusType

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

    • getProductsByParentGenusType

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

    • getProductsByRecordType

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

    • getProductsByCode

      ProductList getProductsByCode(String code) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Product specified by its product code.
      Parameters:
      code - a product code
      Returns:
      the product
      Throws:
      NotFoundException - code not found
      NullArgumentException - code is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method is must be implemented.

    • getProductsByPriceSchedule

      ProductList getProductsByPriceSchedule(Id priceScheduleId) throws OperationFailedException, PermissionDeniedException
      Gets a ProductList containing the given price schedule. In plenary mode, the returned list contains all known products or an error results. Otherwise, the returned list may contain only those products that are accessible through this session.
      Parameters:
      priceScheduleId - a price schedule Id
      Returns:
      the product list
      Throws:
      NullArgumentException - priceScheduleId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method is must be implemented.

    • getProducts

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