OSID - osid.inventory.InventoryProfile Service Interface Definition

Interface	osid.inventory.InventoryProfile
Implements	`osid.OsidProfile`
Description	The inventory profile describes the interoperability of inventory services.
Method	supportsVisibleFederation
Description	Tests if visible federation is supported.
Return	`boolean`		`true` if visible federation is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsItemLookup
Description	Tests if looking up items is supported.
Return	`boolean`		`true` if item lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsItemQuery
Description	Tests if querying items is supported.
Return	`boolean`		`true` if item query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsItemSearch
Description	Tests if searching items is supported.
Return	`boolean`		`true` if item search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsItemAdmin
Description	Tests if an item administrative service is supported.
Return	`boolean`		`true` if item administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsItemNotification
Description	Tests if an item notification service is supported.
Return	`boolean`		`true` if item notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsItemWarehouse
Description	Tests if an item cataloging service is supported.
Return	`boolean`		`true` if item catalog is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsItemWarehouseAssignment
Description	Tests if an item cataloging service is supported. A cataloging service maps items to catalogs.
Return	`boolean`		`true` if item cataloging is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsItemSmartWarehouse
Description	Tests if an item smart warehouse session is available.
Return	`boolean`		`true` if an item smart warehouse session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsStockLookup
Description	Tests if looking up stocks is supported.
Return	`boolean`		`true` if stock lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsStockQuery
Description	Tests if querying stocks is supported.
Return	`boolean`		`true` if stock query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsStockSearch
Description	Tests if searching stocks is supported.
Return	`boolean`		`true` if stock search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsStockAdmin
Description	Tests if stock administrative service is supported.
Return	`boolean`		`true` if stock administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsStockNotification
Description	Tests if a stock notification service is supported.
Return	`boolean`		`true` if stock notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsStockWarehouse
Description	Tests if a stock cataloging service is supported.
Return	`boolean`		`true` if stock catalog is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsStockWarehouseAssignment
Description	Tests if a stock cataloging service is supported. A cataloging service maps stocks to catalogs.
Return	`boolean`		`true` if stock cataloging is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsStockSmartWarehouse
Description	Tests if a stock smart warehouse session is available.
Return	`boolean`		`true` if a stock smart warehouse session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsStockHierarchy
Description	Tests for the availability of a stock hierarchy traversal service.
Return	`boolean`		`true` if stock hierarchy traversal is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsStockHierarchyDesign
Description	Tests for the availability of a stock hierarchy design service.
Return	`boolean`		`true` if stock hierarchy design is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsModelLookup
Description	Tests if looking up models is supported.
Return	`boolean`		`true` if model lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsModelQuery
Description	Tests if querying models is supported.
Return	`boolean`		`true` if model query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsModelSearch
Description	Tests if searching models is supported.
Return	`boolean`		`true` if model search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsModelAdmin
Description	Tests if a stock administrative service is supported.
Return	`boolean`		`true` if model administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsModelNotification
Description	Tests if a model notification service is supported.
Return	`boolean`		`true` if model notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsModelWarehouse
Description	Tests if a model cataloging service is supported.
Return	`boolean`		`true` if model catalog is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsModelWarehouseAssignment
Description	Tests if a model cataloging service is supported. A cataloging service maps models to catalogs.
Return	`boolean`		`true` if model cataloging is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsModelSmartWarehouse
Description	Tests if a model smart warehouse session is available.
Return	`boolean`		`true` if a model smart warehouse session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsInventoryLookup
Description	Tests if looking up inventories is supported.
Return	`boolean`		`true` if inventory lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsInventoryQuery
Description	Tests if querying inventories is supported.
Return	`boolean`		`true` if inventory query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsInventorySearch
Description	Tests if searching inventories is supported.
Return	`boolean`		`true` if inventory search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsInventoryAdmin
Description	Tests if inventory administrative service is supported.
Return	`boolean`		`true` if inventory administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsInventoryNotification
Description	Tests if an inventory notification service is supported.
Return	`boolean`		`true` if inventory notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsInventoryWarehouse
Description	Tests if an inventory cataloging service is supported.
Return	`boolean`		`true` if inventory catalog is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsInventoryWarehouseAssignment
Description	Tests if an inventory cataloging service is supported. A cataloging service maps inventories to catalogs.
Return	`boolean`		`true` if inventory cataloging is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsInventorySmartWarehouse
Description	Tests if an inventory smart warehouse session is available.
Return	`boolean`		`true` if an inventory smart warehouse session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsWarehouseLookup
Description	Tests if looking up warehouses is supported.
Return	`boolean`		`true` if warehouse lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsWarehouseSearch
Description	Tests if searching warehouses is supported.
Return	`boolean`		`true` if warehouse search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsWarehouseQuery
Description	Tests if querying warehouses is supported.
Return	`boolean`		`true` if warehouse query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsWarehouseAdmin
Description	Tests if warehouse administrative service is supported.
Return	`boolean`		`true` if warehouse administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsWarehouseNotification
Description	Tests if a warehouse notification service is supported.
Return	`boolean`		`true` if warehouse notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsWarehouseHierarchy
Description	Tests for the availability of a warehouse hierarchy traversal service.
Return	`boolean`		`true` if warehouse hierarchy traversal is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsWarehouseHierarchyDesign
Description	Tests for the availability of a warehouse hierarchy design service.
Return	`boolean`		`true` if warehouse hierarchy design is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsInventoryBatch
Description	Tests for the availability of a inventory batch service.
Return	`boolean`		`true` if a inventory batch service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsInventoryShipment
Description	Tests for the availability of a inventory shipment service.
Return	`boolean`		`true` if a inventory shipment service is available, `false` otherwise
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 an `Item` record type
Return	`boolean`		`true` if the given record 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` search 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	getStockRecordTypes
Description	Gets the supported `Stock` record types.
Return	`osid.type.TypeList`		a list containing the supported `Stock` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsStockRecordType
Description	Tests if the given `Stock` record type is supported.
Parameters	`osid.type.Type`	`stockRecordType`	a `Type` indicating an `Stock` record type
Return	`boolean`		`true` if the given record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`stockRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getStockSearchRecordTypes
Description	Gets the supported `Stock` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Stock` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsStockSearchRecordType
Description	Tests if the given `Stock` search record type is supported.
Parameters	`osid.type.Type`	`stockSearchRecordType`	a `Type` indicating an `Stock` search record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`stockSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getModelRecordTypes
Description	Gets the supported `Model` record types.
Return	`osid.type.TypeList`		a list containing the supported `Model` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsModelRecordType
Description	Tests if the given `Model` record type is supported.
Parameters	`osid.type.Type`	`modelRecordType`	a `Type` indicating an `Model` record type
Return	`boolean`		`true` if the given record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`modelRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getModelSearchRecordTypes
Description	Gets the supported `Model` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Model` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsModelSearchRecordType
Description	Tests if the given `Model` search record type is supported.
Parameters	`osid.type.Type`	`modelSearchRecordType`	a `Type` indicating an `Model` search record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`modelSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getInventoryRecordTypes
Description	Gets the supported `Inventory` record types.
Return	`osid.type.TypeList`		a list containing the supported `Inventory` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsInventoryRecordType
Description	Tests if the given `Inventory` record type is supported.
Parameters	`osid.type.Type`	`inventoryRecordType`	a `Type` indicating a `Inventory` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`inventoryRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getInventorySearchRecordTypes
Description	Gets the supported `Inventory` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Inventory` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsInventorySearchRecordType
Description	Tests if the given `Inventory` search record type is supported.
Parameters	`osid.type.Type`	`inventorySearchRecordType`	a `Type` indicating a `Inventory` search record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`inventorySearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getWarehouseRecordTypes
Description	Gets the supported `Warehouse` record types.
Return	`osid.type.TypeList`		a list containing the supported `Warehouse` types
Compliance	`mandatory`		This method must be implemented.
Method	supportsWarehouseRecordType
Description	Tests if the given `Warehouse` record type is supported.
Parameters	`osid.type.Type`	`warehouseRecordType`	a `Type` indicating an `Warehouse` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`warehouseRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getWarehouseSearchRecordTypes
Description	Gets the supported `Warehouse` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Warehouse` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsWarehouseSearchRecordType
Description	Tests if the given `Warehouse` search record type is supported.
Parameters	`osid.type.Type`	`warehouseSearchRecordType`	a `Type` indicating an `Warehouse` search record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`warehousesearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.