Interface StoreLookupSession

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

This session provides methods for retrieving Store objects. The Store represents a collection of orders, products, and price schedules.

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

  • Method Details

    • canLookupStores

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

    • useComparativeStoreView

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

    • usePlenaryStoreView

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

    • getStore

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

    • getStoresByIds

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

    • getStoresByGenusType

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

    • getStoresByParentGenusType

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

    • getStoresByRecordType

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

    • getStoresByProvider

      StoreList getStoresByProvider(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Gets a StoreList for the given provider. In plenary mode, the returned list contains all known stores or an error results. Otherwise, the returned list may contain only those stores that are accessible through this session.
      Parameters:
      resourceId - a resource Id
      Returns:
      the returned Store list
      Throws:
      NullArgumentException - resourceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getStores

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