org.osid.inventory.shipment.batch

Interface ShipmentBatchAdminSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession, ShipmentAdminSession

public interface ShipmentBatchAdminSession
extends ShipmentAdminSession

This session creates, updates, and deletes Shipments in bulk. The data for create and update is provided by the consumer via the form object. OsidForms are requested for each create or update and may not be reused.

Create and update operations differ in their usage. To create a Shipment, a ShipmentForm is requested using getShipmentFormsForCreate() specifying the desired record Types or none if no record Types are needed. Each of the returned ShipmentForms will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once a ShipmentForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each ShipmentForm corresponds to an attempted transaction.

The ShipmentForms returned from getShipmentFormsForCreate() may be linked to the originating request through the peer Ids of the ShipmentForm. In the case where there may be duplicates, any ShipmentForm of the same peer Ids may be used for a create operation.

Once a batch of ShipmentForms are submitted for create, a CreateResponse is returned for each ShipmentForm, although the ordering is not defined. Only errors that pertain to the entire create operation are returned from createShipments(), errors specific to an individual ShipmentForm are indicated in the corresponding CreateResponse. CreateResponses may be linked to the originating ShipmentForm through the ShipmentForm Id .

For updates, ShipmentForms are requested to the Shipment Id that is to be updated using getShipmentFormsForUpdate() where the reference Id in the ShipmentForm may be used to link the request. Similarly, the ShipmentForm has metadata about the data that can be updated and it can perform validation before submitting the update. The ShipmentForm can only be used once for a successful update and cannot be reused.

Once a batch of ShipmentForms are submitted for update, an UpdateResponse is returned for each ShipmentForm, although the ordering is not defined. Only errors that pertain to the entire update operation are returned from updateShipments(), errors specific to an individual ShipmentForm are indicated in the corresponding UpdateResponse. UpdateResponses may be linked to the originating ShipmentForm through the ShipmentForm Id.

The delete operations delete Shipments in bulk. To unmap a Shipment from the current Warehouse, the ShipmentWarehouseAssignmentSession should be used. These delete operations attempt to remove the Shipment itself thus removing it from all known Warehouse catalogs. Bulk delete operations return the results in DeleteResponses.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasEntries(AliasRequestList aliasRequests) Adds an Id to an Entry for the purpose of creating compatibility.
AliasResponseList	aliasShipments(AliasRequestList aliasRequests) Adds an Id to a Shipment for the purpose of creating compatibility.
CreateResponseList	createEntries(EntryBatchFormList entryForms) Creates a new set of Entries.
CreateResponseList	createShipments(ShipmentBatchFormList shipmentForms) Creates a new set of Shipments.
DeleteResponseList	deleteAllEntries() Deletes all Entries in this Warehouse .
DeleteResponseList	deleteAllShipments() Deletes all Shipments in this Warehouse .
DeleteResponseList	deleteEntries(IdList entryIds) Deletes entries for the given Ids.
DeleteResponseList	deleteEntriesForShipment(Id shipmentId) Deletes entries for the given shipment.
DeleteResponseList	deleteShipments(IdList shipmentIds) Deletes shipments for the given Ids.
EntryBatchFormList	getEntryFormsForCreate(IdList shipmentIds, Type[] shipmentRecordTypes) Gets the entry forms for creating a bunch of new entries.
EntryBatchFormList	getEntryFormsForUpdate(IdList entryIds) Gets the entry forms for updating an existing set of entries.
ShipmentBatchFormList	getShipmentFormsForCreate(long number, Type[] shipmentRecordTypes) Gets the shipment forms for creating a bunch of new shipments.
ShipmentBatchFormList	getShipmentFormsForUpdate(IdList shipmentIds) Gets the shipment forms for updating an existing set of shipments.
UpdateResponseList	updateEntries(EntryBatchFormList entryForms) Updates existing entries.
UpdateResponseList	updateShipments(ShipmentBatchFormList shipmentForms) Updates existing shipments.

Methods inherited from interface org.osid.inventory.shipment.ShipmentAdminSession

aliasEntry, aliasShipment, canCreateEntries, canCreateEntriesWithRecordTypes, canCreateShipments, canCreateShipmentWithRecordTypes, canDeleteEntries, canDeleteShipments, canManageEntryAliases, canManageShipmentAliases, canUpdateEntries, canUpdateShipments, createEntry, createShipment, deleteEntry, deleteShipment, getEntryFormForCreate, getEntryFormForUpdate, getShipmentFormForCreate, getShipmentFormForUpdate, getWarehouse, getWarehouseId, updateEntry, updateShipment

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getShipmentFormsForCreate

ShipmentBatchFormList getShipmentFormsForCreate(long number,
                                              Type[] shipmentRecordTypes)
                                                throws OperationFailedException,
                                                       PermissionDeniedException

Gets the shipment forms for creating a bunch of new shipments.

Parameters:

number - the number of forms to retrieve

shipmentRecordTypes - array of shipment record types to be included in each create operation or an empty list if none

Returns:

the shipment forms

Throws:

NullArgumentException - shipmentRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to request forms with given record types

Compliance:

mandatory - This method must be implemented.

createShipments

CreateResponseList createShipments(ShipmentBatchFormList shipmentForms)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Creates a new set of Shipments. This method returns an error if the entire operation fails. Otherwise, the status of an individual create operation is indicated in the BatchCreateResponse .

Parameters:

shipmentForms - the shipment forms

Returns:

the create responses

Throws:

NullArgumentException - shipmentForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getShipmentFormsForUpdate

ShipmentBatchFormList getShipmentFormsForUpdate(IdList shipmentIds)
                                                throws NotFoundException,
                                                       OperationFailedException,
                                                       PermissionDeniedException

Gets the shipment forms for updating an existing set of shipments. A new shipment form should be requested for each update transaction.

Parameters:

shipmentIds - the Ids of the Shipment

Returns:

the shipment form

Throws:

NotFoundException - a shipmentId is not found

NullArgumentException - shipmentIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateShipments

UpdateResponseList updateShipments(ShipmentBatchFormList shipmentForms)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Updates existing shipments. This method returns an error if the entire operation fails. Otherwise, the status of an individual update operation is indicated in the BatchCreateResponse .

Parameters:

shipmentForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - shipmentForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllShipments

DeleteResponseList deleteAllShipments()
                                      throws OperationFailedException,
                                             PermissionDeniedException

Deletes all Shipments in this Warehouse .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteShipments

DeleteResponseList deleteShipments(IdList shipmentIds)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Deletes shipments for the given Ids.

Parameters:

shipmentIds - the Ids of the shipments to delete

Returns:

the delete responses

Throws:

NullArgumentException - shipmentIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasShipments

AliasResponseList aliasShipments(AliasRequestList aliasRequests)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Adds an Id to a Shipment for the purpose of creating compatibility. The primary Id of the Shipment is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another shipment, it is reassigned to the given shipment Id.

Parameters:

aliasRequests - the alias requests

Returns:

the alias responses

Throws:

NullArgumentException - aliasRequests is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEntryFormsForCreate

EntryBatchFormList getEntryFormsForCreate(IdList shipmentIds,
                                        Type[] shipmentRecordTypes)
                                          throws NotFoundException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

Gets the entry forms for creating a bunch of new entries. A form is returned for each supplied shipment.

Parameters:

shipmentIds - a list of shipment Ids

shipmentRecordTypes - array of shipment record types to be included in each create operation or an empty list if none

Returns:

the entry forms

Throws:

NotFoundException - a shipmentId is not found

NullArgumentException - shipmentIds or shipmentRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to request forms with given record types

Compliance:

mandatory - This method must be implemented.

createEntries

CreateResponseList createEntries(EntryBatchFormList entryForms)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Creates a new set of Entries. This method returns an error if the entire operation fails. Otherwise, the status of an individual create operation is indicated in the BatchCreateResponse .

Parameters:

entryForms - the entry forms

Returns:

the create responses

Throws:

NullArgumentException - entryForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEntryFormsForUpdate

EntryBatchFormList getEntryFormsForUpdate(IdList entryIds)
                                          throws NotFoundException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

Gets the entry forms for updating an existing set of entries. A new entry form should be requested for each update transaction.

Parameters:

entryIds - the Ids of the Entry

Returns:

the entry form

Throws:

NotFoundException - an entryId is not found

NullArgumentException - entryIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateEntries

UpdateResponseList updateEntries(EntryBatchFormList entryForms)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Updates existing entries. This method returns an error if the entire operation fails. Otherwise, the status of an individual update operation is indicated in the BatchCreateResponse .

Parameters:

entryForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - entryForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllEntries

DeleteResponseList deleteAllEntries()
                                    throws OperationFailedException,
                                           PermissionDeniedException

Deletes all Entries in this Warehouse .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteEntries

DeleteResponseList deleteEntries(IdList entryIds)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Deletes entries for the given Ids.

Parameters:

entryIds - the Ids of the entries to delete

Returns:

the delete responses

Throws:

NullArgumentException - entryIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteEntriesForShipment

DeleteResponseList deleteEntriesForShipment(Id shipmentId)
                                            throws OperationFailedException,
                                                   PermissionDeniedException

Deletes entries for the given shipment.

Parameters:

shipmentId - the Ids of the shipment

Returns:

the delete responses

Throws:

NullArgumentException - shipmentId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasEntries

AliasResponseList aliasEntries(AliasRequestList aliasRequests)
                               throws OperationFailedException,
                                      PermissionDeniedException

Adds an Id to an Entry for the purpose of creating compatibility. The primary Id of the Entry is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another entry, it is reassigned to the given entry Id.

Parameters:

aliasRequests - the alias requests

Returns:

the alias responses

Throws:

NullArgumentException - aliasRequests is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.