Interface OrderingProfile

All Superinterfaces:
OsidProfile, Sourceable
All Known Subinterfaces:
OrderingManager, OrderingProxyManager
public interface OrderingProfile extends OsidProfile

The ordering profile describes the interoperability among ordering services.

  • Method Details

    • supportsVisibleFederation

      boolean supportsVisibleFederation()
      Tests if any item federation is exposed. Federation is exposed when a specific item may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of items appears as a single item.
      Returns:
      true if visible federation is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsMyOrder

      boolean supportsMyOrder()
      Tests for the availability of a my order lookup service.
      Returns:
      true if my order lookup is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsOrderLookup

      boolean supportsOrderLookup()
      Tests for the availability of an order lookup service.
      Returns:
      true if order lookup is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsOrderQuery

      boolean supportsOrderQuery()
      Tests if querying orders is available.
      Returns:
      true if order query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsOrderSearch

      boolean supportsOrderSearch()
      Tests if searching for orders is available.
      Returns:
      true if order search is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsOrderAdmin

      boolean supportsOrderAdmin()
      Tests if searching for orders is available.
      Returns:
      true if order search is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsOrderNotification

      boolean supportsOrderNotification()
      Tests if order notification is available.
      Returns:
      true if order notification is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsOrderStore

      boolean supportsOrderStore()
      Tests if an order to store lookup session is available.
      Returns:
      true if order store lookup session is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsOrderStoreAssignment

      boolean supportsOrderStoreAssignment()
      Tests if an order to store assignment session is available.
      Returns:
      true if order store assignment is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsOrderSmartStore

      boolean supportsOrderSmartStore()
      Tests if an order smart store session is available.
      Returns:
      true if order smart store is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsItemAdmin

      boolean supportsItemAdmin()
      Tests if an item admin session is available.
      Returns:
      true if an item admin session is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsProductLookup

      boolean supportsProductLookup()
      Tests for the availability of a product lookup service.
      Returns:
      true if product lookup is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsProductQuery

      boolean supportsProductQuery()
      Tests if querying products is available.
      Returns:
      true if product query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsProductSearch

      boolean supportsProductSearch()
      Tests if searching for products is available.
      Returns:
      true if product search is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsProductAdmin

      boolean supportsProductAdmin()
      Tests for the availability of a product administrative service for creating and deleting products.
      Returns:
      true if product administration is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsProductNotification

      boolean supportsProductNotification()
      Tests for the availability of a product notification service.
      Returns:
      true if product notification is available, false otherwise
      Compliance:
      mandatory - This method must be implemented in all providers.

    • supportsProductStore

      boolean supportsProductStore()
      Tests if a product to store lookup session is available.
      Returns:
      true if product store lookup session is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsProductStoreAssignment

      boolean supportsProductStoreAssignment()
      Tests if a product to store assignment session is available.
      Returns:
      true if product store assignment is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsProductSmartStore

      boolean supportsProductSmartStore()
      Tests if a product smart store session is available.
      Returns:
      true if product smart store is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsPriceScheduleLookup

      boolean supportsPriceScheduleLookup()
      Tests for the availability of a price schedule lookup service.
      Returns:
      true if price schedule lookup is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsPriceScheduleQuery

      boolean supportsPriceScheduleQuery()
      Tests if querying price schedules is available.
      Returns:
      true if price schedule query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsPriceScheduleSearch

      boolean supportsPriceScheduleSearch()
      Tests if searching for price schedules is available.
      Returns:
      true if price schedule search is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsPriceScheduleAdmin

      boolean supportsPriceScheduleAdmin()
      Tests for the availability of a price schedule administrative service for creating and deleting price schedules.
      Returns:
      true if price schedule administration is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsPriceScheduleNotification

      boolean supportsPriceScheduleNotification()
      Tests for the availability of a price schedule notification service.
      Returns:
      true if price schedule notification is available, false otherwise
      Compliance:
      mandatory - This method must be implemented in all providers.

    • supportsPriceScheduleStore

      boolean supportsPriceScheduleStore()
      Tests if a price schedule to store lookup session is available.
      Returns:
      true if price schedule store lookup session is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsPriceScheduleStoreAssignment

      boolean supportsPriceScheduleStoreAssignment()
      Tests if a price schedule to store assignment session is available.
      Returns:
      true if price schedule store assignment is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsPriceScheduleSmartStore

      boolean supportsPriceScheduleSmartStore()
      Tests if a price schedule smart store session is available.
      Returns:
      true if price schedule smart store is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsStoreLookup

      boolean supportsStoreLookup()
      Tests for the availability of a store lookup service.
      Returns:
      true if store lookup is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsStoreQuery

      boolean supportsStoreQuery()
      Tests if querying stores is available.
      Returns:
      true if store query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsStoreSearch

      boolean supportsStoreSearch()
      Tests if searching for stores is available.
      Returns:
      true if store search is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsStoreAdmin

      boolean supportsStoreAdmin()
      Tests for the availability of a store administrative service for creating and deleting stores.
      Returns:
      true if store administration is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsStoreNotification

      boolean supportsStoreNotification()
      Tests for the availability of a store notification service.
      Returns:
      true if store notification is available, false otherwise
      Compliance:
      mandatory - This method must be implemented in all providers.

    • supportsStoreHierarchy

      boolean supportsStoreHierarchy()
      Tests for the availability of a store hierarchy traversal service.
      Returns:
      true if store hierarchy traversal is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsStoreHierarchyDesign

      boolean supportsStoreHierarchyDesign()
      Tests for the availability of a store hierarchy design service.
      Returns:
      true if store hierarchy design is available, false otherwise
      Compliance:
      mandatory - This method must be implemented in all providers.

    • supportsOrderingBatch

      boolean supportsOrderingBatch()
      Tests for the availability of an ordering batch service.
      Returns:
      true if an ordering batch service is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsOrderingRules

      boolean supportsOrderingRules()
      Tests for the availability of an ordering rules service.
      Returns:
      true if an ordering rules service is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getOrderRecordTypes

      TypeList getOrderRecordTypes()
      Gets the supported Order record types.
      Returns:
      a list containing the supported order record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsOrderRecordType

      boolean supportsOrderRecordType(Type orderRecordType)
      Tests if the given Order record type is supported.
      Parameters:
      orderRecordType - a Type indicating an Order record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - orderRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getOrderSearchRecordTypes

      TypeList getOrderSearchRecordTypes()
      Gets the supported order search record types.
      Returns:
      a list containing the supported order search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsOrderSearchRecordType

      boolean supportsOrderSearchRecordType(Type orderSearchRecordType)
      Tests if the given order search record type is supported.
      Parameters:
      orderSearchRecordType - a Type indicating an order record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - orderSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getItemRecordTypes

      TypeList getItemRecordTypes()
      Gets the supported Item record types.
      Returns:
      a list containing the supported item record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsItemRecordType

      boolean supportsItemRecordType(Type itemRecordType)
      Tests if the given Item record type is supported.
      Parameters:
      itemRecordType - a Type indicating a Item record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - itemRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getItemSearchRecordTypes

      TypeList getItemSearchRecordTypes()
      Gets the supported item search record types.
      Returns:
      a list containing the supported item search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsItemSearchRecordType

      boolean supportsItemSearchRecordType(Type itemSearchRecordType)
      Tests if the given item search record type is supported.
      Parameters:
      itemSearchRecordType - a Type indicating an item record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - itemSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getProductRecordTypes

      TypeList getProductRecordTypes()
      Gets the supported Product record types.
      Returns:
      a list containing the supported product record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsProductRecordType

      boolean supportsProductRecordType(Type productRecordType)
      Tests if the given Product record type is supported.
      Parameters:
      productRecordType - a Type indicating a Product record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - productRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getProductSearchRecordTypes

      TypeList getProductSearchRecordTypes()
      Gets the supported product search record types.
      Returns:
      a list containing the supported product search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsProductSearchRecordType

      boolean supportsProductSearchRecordType(Type productSearchRecordType)
      Tests if the given product search record type is supported.
      Parameters:
      productSearchRecordType - a Type indicating a product record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - productSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getPriceScheduleRecordTypes

      TypeList getPriceScheduleRecordTypes()
      Gets the supported PriceSchedule record types.
      Returns:
      a list containing the supported price schedule record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsPriceScheduleRecordType

      boolean supportsPriceScheduleRecordType(Type priceScheduleRecordType)
      Tests if the given PriceSchedule record type is supported.
      Parameters:
      priceScheduleRecordType - a Type indicating a PriceSchedule record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - priceScheduleRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getPriceScheduleSearchRecordTypes

      TypeList getPriceScheduleSearchRecordTypes()
      Gets the supported price schedule search record types.
      Returns:
      a list containing the supported price schedule search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsPriceScheduleSearchRecordType

      boolean supportsPriceScheduleSearchRecordType(Type priceScheduleSearchRecordType)
      Tests if the given price schedule search record type is supported.
      Parameters:
      priceScheduleSearchRecordType - a Type indicating a price schedule record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - priceScheduleSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getPriceRecordTypes

      TypeList getPriceRecordTypes()
      Gets the supported Price record types.
      Returns:
      a list containing the supported price record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsPriceRecordType

      boolean supportsPriceRecordType(Type priceRecordType)
      Tests if the given Price record type is supported.
      Parameters:
      priceRecordType - a Type indicating a Price record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - priceRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getStoreRecordTypes

      TypeList getStoreRecordTypes()
      Gets the supported Store record types.
      Returns:
      a list containing the supported store record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsStoreRecordType

      boolean supportsStoreRecordType(Type storeRecordType)
      Tests if the given Store record type is supported.
      Parameters:
      storeRecordType - a Type indicating a Store record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - storeRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getStoreSearchRecordTypes

      TypeList getStoreSearchRecordTypes()
      Gets the supported store search record types.
      Returns:
      a list containing the supported store search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsStoreSearchRecordType

      boolean supportsStoreSearchRecordType(Type storeSearchRecordType)
      Tests if the given store search record type is supported.
      Parameters:
      storeSearchRecordType - a Type indicating a store record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - storeSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.