OSID - osid.ordering.OrderingProfile Service Interface Definition

Interface	osid.ordering.OrderingProfile
Implements	`osid.OsidProfile`
Description	The ordering profile describes the interoperability among ordering services.
Method	supportsVisibleFederation
Description	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.
Return	`boolean`		`true` if visible federation is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsMyOrder
Description	Tests for the availability of a my order lookup service.
Return	`boolean`		`true` if my order lookup is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsOrderLookup
Description	Tests for the availability of an order lookup service.
Return	`boolean`		`true` if order lookup is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsOrderQuery
Description	Tests if querying orders is available.
Return	`boolean`		`true` if order query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsOrderSearch
Description	Tests if searching for orders is available.
Return	`boolean`		`true` if order search is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsOrderAdmin
Description	Tests if searching for orders is available.
Return	`boolean`		`true` if order search is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsOrderNotification
Description	Tests if order notification is available.
Return	`boolean`		`true` if order notification is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsOrderStore
Description	Tests if an order to store lookup session is available.
Return	`boolean`		`true` if order store lookup session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsOrderStoreAssignment
Description	Tests if an order to store assignment session is available.
Return	`boolean`		`true` if order store assignment is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsOrderSmartStore
Description	Tests if an order smart store session is available.
Return	`boolean`		`true` if order smart store is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsItemAdmin
Description	Tests if an item admin session is available.
Return	`boolean`		`true` if an item admin session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProductLookup
Description	Tests for the availability of a product lookup service.
Return	`boolean`		`true` if product lookup is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProductQuery
Description	Tests if querying products is available.
Return	`boolean`		`true` if product query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProductSearch
Description	Tests if searching for products is available.
Return	`boolean`		`true` if product search is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProductAdmin
Description	Tests for the availability of a product administrative service for creating and deleting products.
Return	`boolean`		`true` if product administration is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProductNotification
Description	Tests for the availability of a product notification service.
Return	`boolean`		`true` if product notification is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsProductStore
Description	Tests if a product to store lookup session is available.
Return	`boolean`		`true` if product store lookup session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProductStoreAssignment
Description	Tests if a product to store assignment session is available.
Return	`boolean`		`true` if product store assignment is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProductSmartStore
Description	Tests if a product smart store session is available.
Return	`boolean`		`true` if product smart store is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPriceScheduleLookup
Description	Tests for the availability of a price schedule lookup service.
Return	`boolean`		`true` if price schedule lookup is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPriceScheduleQuery
Description	Tests if querying price schedules is available.
Return	`boolean`		`true` if price schedule query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPriceScheduleSearch
Description	Tests if searching for price schedules is available.
Return	`boolean`		`true` if price schedule search is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPriceScheduleAdmin
Description	Tests for the availability of a price schedule administrative service for creating and deleting price schedules.
Return	`boolean`		`true` if price schedule administration is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPriceScheduleNotification
Description	Tests for the availability of a price schedule notification service.
Return	`boolean`		`true` if price schedule notification is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsPriceScheduleStore
Description	Tests if a price schedule to store lookup session is available.
Return	`boolean`		`true` if price schedule store lookup session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPriceScheduleStoreAssignment
Description	Tests if a price schedule to store assignment session is available.
Return	`boolean`		`true` if price schedule store assignment is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPriceScheduleSmartStore
Description	Tests if a price schedule smart store session is available.
Return	`boolean`		`true` if price schedule smart store is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsStoreLookup
Description	Tests for the availability of an store lookup service.
Return	`boolean`		`true` if store lookup is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsStoreQuery
Description	Tests if querying stores is available.
Return	`boolean`		`true` if store query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsStoreSearch
Description	Tests if searching for stores is available.
Return	`boolean`		`true` if store search is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsStoreAdmin
Description	Tests for the availability of a store administrative service for creating and deleting stores.
Return	`boolean`		`true` if store administration is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsStoreNotification
Description	Tests for the availability of a store notification service.
Return	`boolean`		`true` if store notification is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsStoreHierarchy
Description	Tests for the availability of a store hierarchy traversal service.
Return	`boolean`		`true` if store hierarchy traversal is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsStoreHierarchyDesign
Description	Tests for the availability of a store hierarchy design service.
Return	`boolean`		`true` if store hierarchy design is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsOrderingBatch
Description	Tests for the availability of an ordering batch service.
Return	`boolean`		`true` if an ordering batch service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsOrderingRules
Description	Tests for the availability of an ordering rules service.
Return	`boolean`		`true` if an ordering rules service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getOrderRecordTypes
Description	Gets the supported `Order` record types.
Return	`osid.type.TypeList`		a list containing the supported order record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsOrderRecordType
Description	Tests if the given `Order` record type is supported.
Parameters	`osid.type.Type`	`orderRecordType`	a `Type` indicating an `Order` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`orderRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getOrderSearchRecordTypes
Description	Gets the supported order search record types.
Return	`osid.type.TypeList`		a list containing the supported order search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsOrderSearchRecordType
Description	Tests if the given order search record type is supported.
Parameters	`osid.type.Type`	`orderSearchRecordType`	a `Type` indicating an order record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`orderSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getItemRecordTypes
Description	Gets the supported `Item` record types.
Return	`osid.type.TypeList`		a list containing the supported item record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsItemRecordType
Description	Tests if the given `Item` record type is supported.
Parameters	`osid.type.Type`	`itemRecordType`	a `Type` indicating a `Item` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`itemRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getItemSearchRecordTypes
Description	Gets the supported item search record types.
Return	`osid.type.TypeList`		a list containing the supported item search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsItemSearchRecordType
Description	Tests if the given item search record type is supported.
Parameters	`osid.type.Type`	`itemSearchRecordType`	a `Type` indicating an item record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`itemSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getProductRecordTypes
Description	Gets the supported `Product` record types.
Return	`osid.type.TypeList`		a list containing the supported product record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsProductRecordType
Description	Tests if the given `Product` record type is supported.
Parameters	`osid.type.Type`	`productRecordType`	a `Type` indicating a `Product` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`productRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getProductSearchRecordTypes
Description	Gets the supported product search record types.
Return	`osid.type.TypeList`		a list containing the supported product search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsProductSearchRecordType
Description	Tests if the given product search record type is supported.
Parameters	`osid.type.Type`	`productSearchRecordType`	a `Type` indicating a product record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`productSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getPriceScheduleRecordTypes
Description	Gets the supported `PriceSchedule` record types.
Return	`osid.type.TypeList`		a list containing the supported price schedule record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsPriceScheduleRecordType
Description	Tests if the given `PriceSchedule` record type is supported.
Parameters	`osid.type.Type`	`priceScheduleRecordType`	a `Type` indicating a `PriceSchedule` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`priceScheduleRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getPriceScheduleSearchRecordTypes
Description	Gets the supported price schedule search record types.
Return	`osid.type.TypeList`		a list containing the supported price schedule search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsPriceScheduleSearchRecordType
Description	Tests if the given price schedule search record type is supported.
Parameters	`osid.type.Type`	`priceScheduleSearchRecordType`	a `Type` indicating a price schedule record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`priceScheduleSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getPriceRecordTypes
Description	Gets the supported `Price` record types.
Return	`osid.type.TypeList`		a list containing the supported price record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsPriceRecordType
Description	Tests if the given `Price` record type is supported.
Parameters	`osid.type.Type`	`priceRecordType`	a `Type` indicating a `Price` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`priceRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getStoreRecordTypes
Description	Gets the supported `Store` record types.
Return	`osid.type.TypeList`		a list containing the supported store record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsStoreRecordType
Description	Tests if the given `Store` record type is supported.
Parameters	`osid.type.Type`	`storeRecordType`	a `Type` indicating a `Store` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`storeRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getStoreSearchRecordTypes
Description	Gets the supported store search record types.
Return	`osid.type.TypeList`		a list containing the supported store search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsStoreSearchRecordType
Description	Tests if the given store search record type is supported.
Parameters	`osid.type.Type`	`storeSearchRecordType`	a `Type` indicating a store record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`storeSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.