Interface | osid.inventory.shipment.batch.ShipmentBatchAdminSession | ||
---|---|---|---|
Implements | osid.inventory.shipment.ShipmentAdminSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a The Once a batch of For updates, Once a batch of The delete operations delete | ||
Method | getShipmentFormsForCreate | ||
Description |
Gets the shipment forms for creating a bunch of new shipments. | ||
Parameters | cardinal | number | the number of forms to retrieve |
osid.type.Type[] | shipmentRecordTypes | array of shipment record types to be included in each create operation or an empty list if none | |
Return | osid.inventory.shipment.batch.ShipmentBatchFormList | the shipment forms | |
Errors | NULL_ARGUMENT | shipmentRecordTypes is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to request forms with given record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createShipments | ||
Description |
Creates a new set of | ||
Parameters | osid.inventory.shipment.batch.ShipmentBatchFormList | shipmentForms | the shipment forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | shipmentForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getShipmentFormsForUpdate | ||
Description |
Gets the shipment forms for updating an existing set of shipments. A new shipment form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | shipmentIds | the Ids of the Shipment |
Return | osid.inventory.shipment.batch.ShipmentBatchFormList | the shipment form | |
Errors | NOT_FOUND | a shipmentId is not found | |
NULL_ARGUMENT | shipmentIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateShipments | ||
Description |
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
| ||
Parameters | osid.inventory.shipment.batch.ShipmentBatchFormList | shipmentForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | shipmentForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllShipments | ||
Description |
Deletes all | ||
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteShipments | ||
Description |
Deletes shipments for the given | ||
Parameters | osid.id.IdList | shipmentIds | the Ids of the shipments to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | shipmentIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasShipments | ||
Description |
Adds an | ||
Parameters | osid.transaction.batch.AliasRequestList | aliasRequests | the alias requests |
Return | osid.transaction.batch.AliasResponseList | the alias responses | |
Errors | NULL_ARGUMENT | aliasRequests is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEntryFormsForCreate | ||
Description |
Gets the entry forms for creating a bunch of new entries. A form is returned for each supplied shipment. | ||
Parameters | osid.id.IdList | shipmentIds | a list of shipment Ids |
osid.type.Type[] | shipmentRecordTypes | array of shipment record types to be included in each create operation or an empty list if none | |
Return | osid.inventory.shipment.batch.EntryBatchFormList | the entry forms | |
Errors | NOT_FOUND | a shipmentId is not found | |
NULL_ARGUMENT | shipmentIds or shipmentRecordTypes is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to request forms with given record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createEntries | ||
Description |
Creates a new set of | ||
Parameters | osid.inventory.shipment.batch.EntryBatchFormList | entryForms | the entry forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | entryForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEntryFormsForUpdate | ||
Description |
Gets the entry forms for updating an existing set of entries. A new entry form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | entryIds | the Ids of the Entry |
Return | osid.inventory.shipment.batch.EntryBatchFormList | the entry form | |
Errors | NOT_FOUND | an entryId is not found | |
NULL_ARGUMENT | entryIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateEntries | ||
Description |
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 | ||
Parameters | osid.inventory.shipment.batch.EntryBatchFormList | entryForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | entryForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllEntries | ||
Description |
Deletes all | ||
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteEntries | ||
Description |
Deletes entries for the given | ||
Parameters | osid.id.IdList | entryIds | the Ids of the entries to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | entryIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteEntriesForShipment | ||
Description |
Deletes entries for the given shipment. | ||
Parameters | osid.id.Id | shipmentId | the Ids of the shipment |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | shipmentId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasEntries | ||
Description |
Adds an | ||
Parameters | osid.transaction.batch.AliasRequestList | aliasRequests | the alias requests |
Return | osid.transaction.batch.AliasResponseList | the alias responses | |
Errors | NULL_ARGUMENT | aliasRequests is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |