org.osid.inventory.shipment

Interface InventoryShipmentProfile

All Superinterfaces:

OsidProfile, Sourceable

All Known Subinterfaces:

InventoryShipmentManager, InventoryShipmentProxyManager

public interface InventoryShipmentProfile
extends OsidProfile

The billing profile describes the interoperability among billing management services.

Method Summary

Methods

Modifier and Type	Method and Description
TypeList	getEntryRecordTypes() Gets the supported Entry record types.
TypeList	getEntrySearchRecordTypes() Gets the supported Entry search record types.
TypeList	getShipmentRecordTypes() Gets the supported Shipment record types.
TypeList	getShipmentSearchRecordTypes() Gets the supported Shipment search record types.
boolean	supportsEntryRecordType(Type entryRecordType) Tests if the given Entry record type is supported.
boolean	supportsEntrySearchRecordType(Type entrySearchRecordType) Tests if the given Entry search record type is supported.
boolean	supportsInventoryShipmentBatchBatch() Tests for the availability of a inventory shipment batch service.
boolean	supportsShipmentAdmin() Tests if shipment administrative service is supported.
boolean	supportsShipmentLookup() Tests if looking up shipments is supported.
boolean	supportsShipmentNotification() Tests if a shipment notification service is supported.
boolean	supportsShipmentQuery() Tests if querying shipments is supported.
boolean	supportsShipmentRecordType(Type shipmentRecordType) Tests if the given Shipment record type is supported.
boolean	supportsShipmentSearch() Tests if searching shipments is supported.
boolean	supportsShipmentSearchRecordType(Type shipmentSearchRecordType) Tests if the given Shipment search record type is supported.
boolean	supportsShipmentSmartWarehouse() Tests if a shipment smart warehouse session is available.
boolean	supportsShipmentWarehouse() Tests if a warehouseing service is supported.
boolean	supportsShipmentWarehouseAssignment() Tests if a warehouseing service is supported.
boolean	supportsVisibleFederation() Tests if any warehouse federation is exposed.

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

supportsVisibleFederation

boolean supportsVisibleFederation()

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.

Returns:

true if visible federation is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsShipmentLookup

boolean supportsShipmentLookup()

Tests if looking up shipments is supported.

Returns:

true if shipment lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsShipmentQuery

boolean supportsShipmentQuery()

Tests if querying shipments is supported.

Returns:

true if shipment query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsShipmentSearch

boolean supportsShipmentSearch()

Tests if searching shipments is supported.

Returns:

true if shipment search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsShipmentAdmin

boolean supportsShipmentAdmin()

Tests if shipment administrative service is supported.

Returns:

true if shipment administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsShipmentNotification

boolean supportsShipmentNotification()

Tests if a shipment notification service is supported.

Returns:

true if shipment notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsShipmentWarehouse

boolean supportsShipmentWarehouse()

Tests if a warehouseing service is supported.

Returns:

true if warehouseing is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsShipmentWarehouseAssignment

boolean supportsShipmentWarehouseAssignment()

Tests if a warehouseing service is supported. A warehouseing service maps shipments to catalogs.

Returns:

true if warehouseing is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsShipmentSmartWarehouse

boolean supportsShipmentSmartWarehouse()

Tests if a shipment smart warehouse session is available.

Returns:

true if a shipment smart warehouse session is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsInventoryShipmentBatchBatch

boolean supportsInventoryShipmentBatchBatch()

Tests for the availability of a inventory shipment batch service.

Returns:

true if an inventory shipment batch service is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getShipmentRecordTypes

TypeList getShipmentRecordTypes()

Gets the supported Shipment record types.

Returns:

a list containing the supported Shipment record types

Compliance:

mandatory - This method must be implemented.

supportsShipmentRecordType

boolean supportsShipmentRecordType(Type shipmentRecordType)

Tests if the given Shipment record type is supported.

Parameters:

shipmentRecordType - a Type indicating a Shipment record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - shipmentRecordType is null

Compliance:

mandatory - This method must be implemented.

getShipmentSearchRecordTypes

TypeList getShipmentSearchRecordTypes()

Gets the supported Shipment search record types.

Returns:

a list containing the supported Shipment search record types

Compliance:

mandatory - This method must be implemented.

supportsShipmentSearchRecordType

boolean supportsShipmentSearchRecordType(Type shipmentSearchRecordType)

Tests if the given Shipment search record type is supported.

Parameters:

shipmentSearchRecordType - a Type indicating a Shipment search record type

Returns:

true if the given search record type is supported, false otherwise

Throws:

NullArgumentException - shipmentSearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getEntryRecordTypes

TypeList getEntryRecordTypes()

Gets the supported Entry record types.

Returns:

a list containing the supported Entry record types

Compliance:

mandatory - This method must be implemented.

supportsEntryRecordType

boolean supportsEntryRecordType(Type entryRecordType)

Tests if the given Entry record type is supported.

Parameters:

entryRecordType - a Type indicating an Entry record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - entryRecordType is null

Compliance:

mandatory - This method must be implemented.

getEntrySearchRecordTypes

TypeList getEntrySearchRecordTypes()

Gets the supported Entry search record types.

Returns:

a list containing the supported Entry search record types

Compliance:

mandatory - This method must be implemented.

supportsEntrySearchRecordType

boolean supportsEntrySearchRecordType(Type entrySearchRecordType)

Tests if the given Entry search record type is supported.

Parameters:

entrySearchRecordType - a Type indicating an Entry search record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - entrySearchRecordType is null

Compliance:

mandatory - This method must be implemented.