OSID - osid.inventory.shipment.ShipmentAdminSession Service Interface Definition

Interface	osid.inventory.shipment.ShipmentAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.inventory.shipment.batch.ShipmentBatchAdminSession`
Used By	`osid.inventory.shipment.InventoryShipmentManager`
Used By	`osid.inventory.shipment.InventoryShipmentProxyManager`
Description	This session creates, updates, and deletes `Shipments`. 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 `getShipmentFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `ShipmentForm` 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 the `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. For updates, `ShipmentForms` are requested to the `Shipment` `Id` that is to be updated using `getShipmentFormForUpdate()`. 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. The delete operations delete `Shipments`. 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. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getWarehouseId
Description	Gets the `Warehouse` `Id` associated with this session.
Return	`osid.id.Id`		the `Warehouse Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getWarehouse
Description	Gets the `Warehouse` associated with this session.
Return	`osid.inventory.Warehouse`		the warehouse
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateShipments
Description	Tests if this user can create `Shipments`. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Shipment` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.
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 `Shipment` using the desired record types. While `InventoryShipmentManager.getShipmentRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Shipment`. Providing an empty array tests if a `Shipment` can be created with no records.
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 `Shipment`.
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 `Shipments`. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Shipment` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.
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 `Shipments`. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Shipment` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.
Return	`boolean`		`false` if `Shipment` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteShipment
Description	Deletes a `Shipment`.
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 `Id` aliases for `Shipments`. A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.
Return	`boolean`		`false` if `Shipment` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasShipment
Description	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` performs as an alias to the primary `Id`. If the alias is a pointer to another shipment, it is reassigned to the given shipment `Id`.
Parameters	`osid.id.Id`	`shipmentId`	the `Id` of a `Shipment`
Parameters	`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 `Entries`. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an `Entry` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.
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 `Entry` using the desired record types. While `InventoryShippingManager.getEntryRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Entry`. Providing an empty array tests if an `Entry` can be created with no records.
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`
Parameters	`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 `Entry`.
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 `Entries`. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `Entry` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.
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 `Entries`. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `Entry` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.
Return	`boolean`		`false` if `Entry` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteEntry
Description	Deletes an `Entry`.
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 `Id` aliases for `Entries`. A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.
Return	`boolean`		`false` if `Entry` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasEntry
Description	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` performs as an alias to the primary `Id`. If the alias is a pointer to another entry, it is reassigned to the given entry `Id`.
Parameters	`osid.id.Id`	`entryId`	the `Id` of an `Entry`
Parameters	`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.