public interface OrderingProfile extends OsidProfile
The ordering profile describes the interoperability among ordering services.
Modifier and Type | Method and Description |
---|---|
TypeList |
getItemRecordTypes()
Gets the supported
Item record types. |
TypeList |
getItemSearchRecordTypes()
Gets the supported item search record types.
|
TypeList |
getOrderRecordTypes()
Gets the supported
Order record types. |
TypeList |
getOrderSearchRecordTypes()
Gets the supported order search record types.
|
TypeList |
getPriceRecordTypes()
Gets the supported
Price record types. |
TypeList |
getPriceScheduleRecordTypes()
Gets the supported
PriceSchedule record types. |
TypeList |
getPriceScheduleSearchRecordTypes()
Gets the supported price schedule search record types.
|
TypeList |
getProductRecordTypes()
Gets the supported
Product record types. |
TypeList |
getProductSearchRecordTypes()
Gets the supported product search record types.
|
TypeList |
getStoreRecordTypes()
Gets the supported
Store record types. |
TypeList |
getStoreSearchRecordTypes()
Gets the supported store search record types.
|
boolean |
supportsItemAdmin()
Tests if an item admin session is available.
|
boolean |
supportsItemRecordType(Type itemRecordType)
Tests if the given
Item record type is supported. |
boolean |
supportsItemSearchRecordType(Type itemSearchRecordType)
Tests if the given item search record type is supported.
|
boolean |
supportsMyOrder()
Tests for the availability of a my order lookup service.
|
boolean |
supportsOrderAdmin()
Tests if searching for orders is available.
|
boolean |
supportsOrderingBatch()
Tests for the availability of an ordering batch service.
|
boolean |
supportsOrderingRules()
Tests for the availability of an ordering rules service.
|
boolean |
supportsOrderLookup()
Tests for the availability of an order lookup service.
|
boolean |
supportsOrderNotification()
Tests if order notification is available.
|
boolean |
supportsOrderQuery()
Tests if querying orders is available.
|
boolean |
supportsOrderRecordType(Type orderRecordType)
Tests if the given
Order record type is supported. |
boolean |
supportsOrderSearch()
Tests if searching for orders is available.
|
boolean |
supportsOrderSearchRecordType(Type orderSearchRecordType)
Tests if the given order search record type is supported.
|
boolean |
supportsOrderSmartStore()
Tests if an order smart store session is available.
|
boolean |
supportsOrderStore()
Tests if an order to store lookup session is available.
|
boolean |
supportsOrderStoreAssignment()
Tests if an order to store assignment session is available.
|
boolean |
supportsPriceRecordType(Type priceRecordType)
Tests if the given
Price record type is supported. |
boolean |
supportsPriceScheduleAdmin()
Tests for the availability of a price schedule administrative service
for creating and deleting price schedules.
|
boolean |
supportsPriceScheduleLookup()
Tests for the availability of a price schedule lookup service.
|
boolean |
supportsPriceScheduleNotification()
Tests for the availability of a price schedule notification service.
|
boolean |
supportsPriceScheduleQuery()
Tests if querying price schedules is available.
|
boolean |
supportsPriceScheduleRecordType(Type priceScheduleRecordType)
Tests if the given
PriceSchedule record type is
supported. |
boolean |
supportsPriceScheduleSearch()
Tests if searching for price schedules is available.
|
boolean |
supportsPriceScheduleSearchRecordType(Type priceScheduleSearchRecordType)
Tests if the given price schedule search record type is supported.
|
boolean |
supportsPriceScheduleSmartStore()
Tests if a price schedule smart store session is available.
|
boolean |
supportsPriceScheduleStore()
Tests if a price schedule to store lookup session is available.
|
boolean |
supportsPriceScheduleStoreAssignment()
Tests if a price schedule to store assignment session is available.
|
boolean |
supportsProductAdmin()
Tests for the availability of a product administrative service for
creating and deleting products.
|
boolean |
supportsProductLookup()
Tests for the availability of a product lookup service.
|
boolean |
supportsProductNotification()
Tests for the availability of a product notification service.
|
boolean |
supportsProductQuery()
Tests if querying products is available.
|
boolean |
supportsProductRecordType(Type productRecordType)
Tests if the given
Product record type is supported. |
boolean |
supportsProductSearch()
Tests if searching for products is available.
|
boolean |
supportsProductSearchRecordType(Type productSearchRecordType)
Tests if the given product search record type is supported.
|
boolean |
supportsProductSmartStore()
Tests if a product smart store session is available.
|
boolean |
supportsProductStore()
Tests if a product to store lookup session is available.
|
boolean |
supportsProductStoreAssignment()
Tests if a product to store assignment session is available.
|
boolean |
supportsStoreAdmin()
Tests for the availability of a store administrative service for
creating and deleting stores.
|
boolean |
supportsStoreHierarchy()
Tests for the availability of a store hierarchy traversal service.
|
boolean |
supportsStoreHierarchyDesign()
Tests for the availability of a store hierarchy design service.
|
boolean |
supportsStoreLookup()
Tests for the availability of an store lookup service.
|
boolean |
supportsStoreNotification()
Tests for the availability of a store notification service.
|
boolean |
supportsStoreQuery()
Tests if querying stores is available.
|
boolean |
supportsStoreRecordType(Type storeRecordType)
Tests if the given
Store record type is supported. |
boolean |
supportsStoreSearch()
Tests if searching for stores is available.
|
boolean |
supportsStoreSearchRecordType(Type storeSearchRecordType)
Tests if the given store search record type is supported.
|
boolean |
supportsVisibleFederation()
Tests if any item federation is exposed.
|
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
boolean supportsVisibleFederation()
true
if visible federation is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsMyOrder()
true
if my order lookup is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsOrderLookup()
true
if order lookup is available, false
otherwisemandatory
- This method must be implemented. boolean supportsOrderQuery()
true
if order query is available, false
otherwisemandatory
- This method must be implemented. boolean supportsOrderSearch()
true
if order search is available, false
otherwisemandatory
- This method must be implemented. boolean supportsOrderAdmin()
true
if order search is available, false
otherwisemandatory
- This method must be implemented. boolean supportsOrderNotification()
true
if order notification is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsOrderStore()
true
if order store lookup session is
supported, false
otherwisemandatory
- This method must be implemented. boolean supportsOrderStoreAssignment()
true
if order store assignment is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsOrderSmartStore()
true
if order smart store is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsItemAdmin()
true
if an item admin session is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsProductLookup()
true
if product lookup is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsProductQuery()
true
if product query is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsProductSearch()
true
if product search is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsProductAdmin()
true
if product administration is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsProductNotification()
true
if product notification is available,
false
otherwisemandatory
- This method must be implemented in all
providers. boolean supportsProductStore()
true
if product store lookup session is
supported, false
otherwisemandatory
- This method must be implemented. boolean supportsProductStoreAssignment()
true
if product store assignment is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsProductSmartStore()
true
if product smart store is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsPriceScheduleLookup()
true
if price schedule lookup is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsPriceScheduleQuery()
true
if price schedule query is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsPriceScheduleSearch()
true
if price schedule search is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsPriceScheduleAdmin()
true
if price schedule administration is
available, false
otherwisemandatory
- This method must be implemented. boolean supportsPriceScheduleNotification()
true
if price schedule notification is
available, false
otherwisemandatory
- This method must be implemented in all
providers. boolean supportsPriceScheduleStore()
true
if price schedule store lookup session is
supported, false
otherwisemandatory
- This method must be implemented. boolean supportsPriceScheduleStoreAssignment()
true
if price schedule store assignment is
supported, false
otherwisemandatory
- This method must be implemented. boolean supportsPriceScheduleSmartStore()
true
if price schedule smart store is
supported, false
otherwisemandatory
- This method must be implemented. boolean supportsStoreLookup()
true
if store lookup is available, false
otherwisemandatory
- This method must be implemented. boolean supportsStoreQuery()
true
if store query is available, false
otherwisemandatory
- This method must be implemented. boolean supportsStoreSearch()
true
if store search is available, false
otherwisemandatory
- This method must be implemented. boolean supportsStoreAdmin()
true
if store administration is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsStoreNotification()
true
if store notification is available,
false
otherwisemandatory
- This method must be implemented in all
providers. boolean supportsStoreHierarchy()
true
if store hierarchy traversal is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsStoreHierarchyDesign()
true
if store hierarchy design is available,
false
otherwisemandatory
- This method must be implemented in all
providers. boolean supportsOrderingBatch()
true
if an ordering batch service is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsOrderingRules()
true
if an ordering rules service is available,
false
otherwisemandatory
- This method must be implemented. TypeList getOrderRecordTypes()
Order
record types.mandatory
- This method must be implemented. boolean supportsOrderRecordType(Type orderRecordType)
Order
record type is supported.orderRecordType
- a Type
indicating an
Order
record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
- orderRecordType
is null
mandatory
- This method must be implemented. TypeList getOrderSearchRecordTypes()
mandatory
- This method must be implemented. boolean supportsOrderSearchRecordType(Type orderSearchRecordType)
orderSearchRecordType
- a Type
indicating an
order record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
- orderSearchRecordType
is null
mandatory
- This method must be implemented. TypeList getItemRecordTypes()
Item
record types.mandatory
- This method must be implemented. boolean supportsItemRecordType(Type itemRecordType)
Item
record type is supported.itemRecordType
- a Type
indicating a Item
record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
- itemRecordType
is null
mandatory
- This method must be implemented. TypeList getItemSearchRecordTypes()
mandatory
- This method must be implemented. boolean supportsItemSearchRecordType(Type itemSearchRecordType)
itemSearchRecordType
- a Type
indicating an item
record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
- itemSearchRecordType
is null
mandatory
- This method must be implemented. TypeList getProductRecordTypes()
Product
record types.mandatory
- This method must be implemented. boolean supportsProductRecordType(Type productRecordType)
Product
record type is supported.productRecordType
- a Type
indicating a
Product
record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
- productRecordType
is null
mandatory
- This method must be implemented. TypeList getProductSearchRecordTypes()
mandatory
- This method must be implemented. boolean supportsProductSearchRecordType(Type productSearchRecordType)
productSearchRecordType
- a Type
indicating a
product record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
- productSearchRecordType
is null
mandatory
- This method must be implemented. TypeList getPriceScheduleRecordTypes()
PriceSchedule
record types.mandatory
- This method must be implemented. boolean supportsPriceScheduleRecordType(Type priceScheduleRecordType)
PriceSchedule
record type is
supported.priceScheduleRecordType
- a Type
indicating a
PriceSchedule
record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
- priceScheduleRecordType
is null
mandatory
- This method must be implemented. TypeList getPriceScheduleSearchRecordTypes()
mandatory
- This method must be implemented. boolean supportsPriceScheduleSearchRecordType(Type priceScheduleSearchRecordType)
priceScheduleSearchRecordType
- a Type
indicating
a price schedule record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
-
priceScheduleSearchRecordType
is null
mandatory
- This method must be implemented. TypeList getPriceRecordTypes()
Price
record types.mandatory
- This method must be implemented. boolean supportsPriceRecordType(Type priceRecordType)
Price
record type is supported.priceRecordType
- a Type
indicating a
Price
record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
- priceRecordType
is null
mandatory
- This method must be implemented. TypeList getStoreRecordTypes()
Store
record types.mandatory
- This method must be implemented. boolean supportsStoreRecordType(Type storeRecordType)
Store
record type is supported.storeRecordType
- a Type
indicating a
Store
record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
- storeRecordType
is null
mandatory
- This method must be implemented. TypeList getStoreSearchRecordTypes()
mandatory
- This method must be implemented. boolean supportsStoreSearchRecordType(Type storeSearchRecordType)
storeSearchRecordType
- a Type
indicating a store
record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
- storeSearchRecordType
is null
mandatory
- This method must be implemented.