Interface PriceScheduleLookupSession

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

This session provides methods for retrieving PriceSchedule objects. The PriceSchedule represents a collection of prices.

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 price schedules defined explicitly in the current store. Using an isolated view is useful for managing price schedules with the PriceScheduleAdminSession .
  • federated store view: All priice schedule lookup methods in this session operate, retrieve and pertain to all price schedules 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.

    • canLookupPriceSchedules

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

    • useComparativePriceScheduleView

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

    • usePlenaryPriceScheduleView

      void usePlenaryPriceScheduleView()
      A complete view of the PriceSchedule 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 schedules 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.

    • getPriceSchedule

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

    • getPriceScheduleByPrice

      PriceSchedule getPriceScheduleByPrice(Id priceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the PriceSchedule by a Price Id .
      Parameters:
      priceId - Id of a Price
      Returns:
      the price schedule
      Throws:
      NotFoundException - priceId not found
      NullArgumentException - priceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method is must be implemented.

    • getPriceSchedulesByIds

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

    • getPriceSchedulesByGenusType

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

    • getPriceSchedulesByParentGenusType

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

    • getPriceSchedulesByRecordType

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

    • getPriceSchedules

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