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.
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.
|
aliasEntry, aliasShipment, canCreateEntries, canCreateEntriesWithRecordTypes, canCreateShipments, canCreateShipmentWithRecordTypes, canDeleteEntries, canDeleteShipments, canManageEntryAliases, canManageShipmentAliases, canUpdateEntries, canUpdateShipments, createEntry, createShipment, deleteEntry, deleteShipment, getEntryFormForCreate, getEntryFormForUpdate, getShipmentFormForCreate, getShipmentFormForUpdate, getWarehouse, getWarehouseId, updateEntry, updateShipment
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
ShipmentBatchFormList getShipmentFormsForCreate(long number, Type[] shipmentRecordTypes) throws OperationFailedException, PermissionDeniedException
number
- the number of forms to retrieveshipmentRecordTypes
- array of shipment record types to be
included in each create operation or an empty list if noneNullArgumentException
- shipmentRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createShipments(ShipmentBatchFormList shipmentForms) throws OperationFailedException, PermissionDeniedException
Shipments.
This method returns an
error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.shipmentForms
- the shipment formsNullArgumentException
- shipmentForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ShipmentBatchFormList getShipmentFormsForUpdate(IdList shipmentIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
shipmentIds
- the Ids
of the Shipment
NotFoundException
- a shipmentId
is not
foundNullArgumentException
- shipmentIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateShipments(ShipmentBatchFormList shipmentForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.shipmentForms
- the form containing the elements to be updatedNullArgumentException
- shipmentForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllShipments() throws OperationFailedException, PermissionDeniedException
Shipments
in this Warehouse
.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteShipments(IdList shipmentIds) throws OperationFailedException, PermissionDeniedException
Ids.
shipmentIds
- the Ids
of the shipments to deleteNullArgumentException
- shipmentIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasShipments(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
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.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. EntryBatchFormList getEntryFormsForCreate(IdList shipmentIds, Type[] shipmentRecordTypes) throws NotFoundException, OperationFailedException, PermissionDeniedException
shipmentIds
- a list of shipment Ids
shipmentRecordTypes
- array of shipment record types to be
included in each create operation or an empty list if noneNotFoundException
- a shipmentId
is not
foundNullArgumentException
- shipmentIds
or
shipmentRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createEntries(EntryBatchFormList entryForms) throws OperationFailedException, PermissionDeniedException
Entries.
This method returns an
error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.entryForms
- the entry formsNullArgumentException
- entryForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. EntryBatchFormList getEntryFormsForUpdate(IdList entryIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
entryIds
- the Ids
of the Entry
NotFoundException
- an entryId
is not
foundNullArgumentException
- entryIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateEntries(EntryBatchFormList entryForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.entryForms
- the form containing the elements to be updatedNullArgumentException
- entryForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllEntries() throws OperationFailedException, PermissionDeniedException
Entries
in this Warehouse
.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteEntries(IdList entryIds) throws OperationFailedException, PermissionDeniedException
Ids.
entryIds
- the Ids
of the entries to deleteNullArgumentException
- entryIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteEntriesForShipment(Id shipmentId) throws OperationFailedException, PermissionDeniedException
shipmentId
- the Ids
of the shipmentNullArgumentException
- shipmentId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasEntries(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
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.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.