OSID - osid.inventory.shipment.InventoryShipmentProfile Service Interface Definition

Interface	osid.inventory.shipment.InventoryShipmentProfile
Implements	`osid.OsidProfile`
Description	The billing profile describes the interoperability among billing management services.
Method	supportsVisibleFederation
Description	Tests if any warehouse federation is exposed. Federation is exposed when a specific warehouse may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of catalogs appears as a single catalog.
Return	`boolean`		`true` if visible federation is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsShipmentLookup
Description	Tests if looking up shipments is supported.
Return	`boolean`		`true` if shipment lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsShipmentQuery
Description	Tests if querying shipments is supported.
Return	`boolean`		`true` if shipment query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsShipmentSearch
Description	Tests if searching shipments is supported.
Return	`boolean`		`true` if shipment search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsShipmentAdmin
Description	Tests if shipment administrative service is supported.
Return	`boolean`		`true` if shipment administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsShipmentNotification
Description	Tests if a shipment notification service is supported.
Return	`boolean`		`true` if shipment notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsShipmentWarehouse
Description	Tests if a warehouseing service is supported.
Return	`boolean`		`true` if warehouseing is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsShipmentWarehouseAssignment
Description	Tests if a warehouseing service is supported. A warehouseing service maps shipments to catalogs.
Return	`boolean`		`true` if warehouseing is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsShipmentSmartWarehouse
Description	Tests if a shipment smart warehouse session is available.
Return	`boolean`		`true` if a shipment smart warehouse session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsInventoryShipmentBatchBatch
Description	Tests for the availability of a inventory shipment batch service.
Return	`boolean`		`true` if an inventory shipment batch service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getShipmentRecordTypes
Description	Gets the supported `Shipment` record types.
Return	`osid.type.TypeList`		a list containing the supported `Shipment` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsShipmentRecordType
Description	Tests if the given `Shipment` record type is supported.
Parameters	`osid.type.Type`	`shipmentRecordType`	a `Type` indicating a `Shipment` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`shipmentRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getShipmentSearchRecordTypes
Description	Gets the supported `Shipment` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Shipment` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsShipmentSearchRecordType
Description	Tests if the given `Shipment` search record type is supported.
Parameters	`osid.type.Type`	`shipmentSearchRecordType`	a `Type` indicating a `Shipment` search record type
Return	`boolean`		`true` if the given search record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`shipmentSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getEntryRecordTypes
Description	Gets the supported `Entry` record types.
Return	`osid.type.TypeList`		a list containing the supported `Entry` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsEntryRecordType
Description	Tests if the given `Entry` record type is supported.
Parameters	`osid.type.Type`	`entryRecordType`	a `Type` indicating an `Entry` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`entryRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getEntrySearchRecordTypes
Description	Gets the supported `Entry` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Entry` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsEntrySearchRecordType
Description	Tests if the given `Entry` search record type is supported.
Parameters	`osid.type.Type`	`entrySearchRecordType`	a `Type` indicating an `Entry` search record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`entrySearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.