Interface | osid.inventory.shipment.ShipmentAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a For updates, The delete operations delete This session includes an | ||
Method | getWarehouseId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Warehouse Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getWarehouse | ||
Description |
Gets the | ||
Return | osid.inventory.Warehouse | the warehouse | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreateShipments | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Shipment creation is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateShipmentWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | shipmentRecordTypes | array of shipment record types |
Return | boolean | true if Shipment creation using the specified
record Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | shipmentRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getShipmentFormForCreate | ||
Description |
Gets the shipment form for creating new shipments. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | shipmentRecordTypes | array of shipment record types |
Return | osid.inventory.shipment.ShipmentForm | the shipment form | |
Errors | NULL_ARGUMENT | shipmentRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to get form for requested record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createShipment | ||
Description |
Creates a new | ||
Parameters | osid.inventory.shipment.ShipmentForm | shipmentForm | the form for this Shipment |
Return | osid.inventory.shipment.Shipment | the new Shipment | |
Errors | ILLEGAL_STATE | shipmentForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | shipmentForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | shipmentForm did not originate from getShipmentFormForCreate()
| ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateShipments | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Shipment modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getShipmentFormForUpdate | ||
Description |
Gets the shipment form for updating an existing shipment. A new shipment form should be requested for each update transaction. | ||
Parameters | osid.id.Id | shipmentId | the Id of the Shipment |
Return | osid.inventory.shipment.ShipmentForm | the shipment form | |
Errors | NOT_FOUND | shipmentId is not found | |
NULL_ARGUMENT | shipmentId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateShipment | ||
Description |
Updates an existing shipment. | ||
Parameters | osid.inventory.shipment.ShipmentForm | shipmentForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | shipmentForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | shipmentForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | shipmentForm did not originate from getShipmentFormForUpdate()
| ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteShipments | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Shipment deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteShipment | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | shipmentId | the Id of the Shipment to remove |
Errors | NOT_FOUND | shipmentId not found | |
NULL_ARGUMENT | shipmentId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageShipmentAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Shipment aliasing is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasShipment | ||
Description |
Adds an | ||
Parameters | osid.id.Id | shipmentId | the Id of a Shipment |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is in use as a primary Id | |
NOT_FOUND | shipmentId not found | ||
NULL_ARGUMENT | shipmentId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreateEntries | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Entry creation is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateEntriesWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | entryRecordTypes | array of entry record types |
Return | boolean | true if Entry creation using the specified
record Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | entryRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getEntryFormForCreate | ||
Description |
Gets the entry form for creating new entries. A new form should be requested for each create transaction. | ||
Parameters | osid.id.Id | shipmentId | a shipment Id |
osid.type.Type[] | entryRecordTypes | array of entry record types | |
Return | osid.inventory.shipment.EntryForm | the entry form | |
Errors | NOT_FOUND | shipmentId is not found | |
NULL_ARGUMENT | entryRecordTypes or shipmentId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to get form for requested record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createEntry | ||
Description |
Creates a new | ||
Parameters | osid.inventory.shipment.EntryForm | entryForm | the form for this Entry |
Return | osid.inventory.shipment.Entry | the new Entry | |
Errors | ILLEGAL_STATE | entryForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | entryForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | entry did not originate from getEntryFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateEntries | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Entry modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getEntryFormForUpdate | ||
Description |
Gets the entry form for updating an existing entry. A new entry form should be requested for each update transaction. | ||
Parameters | osid.id.Id | entryId | the Id of the Entry |
Return | osid.inventory.shipment.EntryForm | the entry form | |
Errors | NOT_FOUND | entryId is not found | |
NULL_ARGUMENT | entryId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateEntry | ||
Description |
Updates an existing entry. | ||
Parameters | osid.inventory.shipment.EntryForm | entryForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | entryForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | entryForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | entryForm did not originate from getEntryFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteEntries | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Entry deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteEntry | ||
Description |
Deletes an | ||
Parameters | osid.id.Id | entryId | the Id of the Entry to remove |
Errors | NOT_FOUND | entryId not found | |
NULL_ARGUMENT | entryId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageEntryAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Entry aliasing is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasEntry | ||
Description |
Adds an | ||
Parameters | osid.id.Id | entryId | the Id of an Entry |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is in use as a primary Id | |
NOT_FOUND | entryId not found | ||
NULL_ARGUMENT | entryId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |