Interface PriceEnablerLookupSession

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

This session provides methods for retrieving PriceEnablers .

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 price enabler methods in this session operate, retrieve and pertain to price enablers defined explicitly in the current store. Using an isolated view is useful for managing PriceEnablers with the PriceEnablerAdminSession .
  • federated store view: All price enabler methods in this session operate, retrieve and pertain to all price enablers defined in this store and any other price enablers implicitly available in this store through store inheritence.

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods useFederatedDistributorView() and useIsolatedDistributorView() behave as a radio group and one should be selected before invoking the methods in this session.

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

    • canLookupPriceEnablers

      boolean canLookupPriceEnablers()
      Tests if this user can perform PriceEnablers 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 opt not to offer lookup operations to unauthorized users.
      Returns:
      false if lookup methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativePriceEnablerView

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

    • usePlenaryPriceEnablerView

      void usePlenaryPriceEnablerView()
      A complete view of the PriceEnabler 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 price enablers 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 lookups to this store only.
      Compliance:
      mandatory - This method is must be implemented.

    • useActivePriceEnablerView

      void useActivePriceEnablerView()
      Only active price enablers are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • useAnyStatusPriceEnablerView

      void useAnyStatusPriceEnablerView()
      All active and inactive price enablers are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • useEffectivePriceEnablerView

      void useEffectivePriceEnablerView()
      Only price enablers whose effective dates are current are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • useAnyEffectivePriceEnablerView

      void useAnyEffectivePriceEnablerView()
      All price enablers of any effective dates are returned by all methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • getPriceEnabler

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

    • getPriceEnablersByIds

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

    • getPriceEnablersByGenusType

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

    • getPriceEnablersByParentGenusType

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

    • getPriceEnablersByRecordType

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

    • getPriceEnablersByDate

      PriceEnablerList getPriceEnablersByDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a PriceEnablerList within the given date range. In plenary mode, the returned list contains all known price enablers or an error results. Otherwise, the returned list may contain only those price enablers that are accessible through this session.
      Parameters:
      from - a start date
      to - an end date
      Returns:
      the returned PriceEnabler list
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - from or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getPriceEnablers

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