OSID - osid.ordering.OrderItemAdminSession Service Interface Definition

Interface	osid.ordering.OrderItemAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.ordering.batch.OrderItemBatchAdminSession`
Used By	`osid.ordering.OrderingManager`
Used By	`osid.ordering.OrderingProxyManager`
Description	This session creates, updates, and deletes `OrderItems`. 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 an `OrderItem`, an `OrderItemForm` is requested using `getOrderItemFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `OrderItemForm` will indicate that it is to be used with a create operation and can be used to examine metadata or validate data prior to creation. Once the `OrderItemForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `OrderItemForm` corresponds to an attempted transaction. For updates, `OrderItemForms` are requested to the `OrderItem` `Id` that is to be updated using `getOrderItemFormForUpdate()`. Similarly, the `OrderItemForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `OrderItemForm` can only be used once for a successful update and cannot be reused. The delete operations delete `OrderItems`. To unmap an `OrderItem` from the current `Store`, the `OrderItemStoreAssignmentSession` should be used. These delete operations attempt to remove the `OrderItem` itself thus removing it from all known `Store` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id. Like all `OsidSessions`, `OrderItemAdminSessions` are dedicated to single processing threads and a single authenticated user.
Method	getStoreId
Description	Gets the `Store` `Id` associated with this session.
Return	`osid.id.Id`		the `Store Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getStore
Description	Gets the `Store` associated with this session.
Return	`osid.ordering.Store`		the store
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateOrderItems
Description	Tests if this user can create `OrderItems`. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an `OrderItem` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may not wish to offer create operations to unauthorized users.
Return	`boolean`		`false` if `OrderItem` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateOrderItemWithRecordTypes
Description	Tests if this user can create a single `OrderItem` using the desired record types. While `OrderingManager.getOrderItemRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `OrderItem`. Providing an empty array tests if an `OrderItem` can be created with no records.
Parameters	`osid.type.Type[]`	`orderItemRecordTypes`	array of order item record types
Return	`boolean`		`true` if `OrderItem` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`orderItemRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getOrderItemFormForCreate
Description	Gets the order item form for creating new order items. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`orderId`	the order `Id`
	`osid.id.Id`	`productId`	the product `Id`
	`osid.type.Type[]`	`orderItemRecordTypes`	array of order item record types
Return	`osid.ordering.OrderItemForm`		the order item form
Errors	NOT_FOUND		`orderId` or `productId` is not found
	NULL_ARGUMENT		`orderId, productId` or `orderItemRecordTypes` 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	createOrderItem
Description	Creates a new `OrderItem`.
Parameters	`osid.ordering.OrderItemForm`	`orderItemForm`	the form for this `OrderItem`
Return	`osid.ordering.OrderItem`		the new `OrderItem`
Errors	ILLEGAL_STATE		`orderItemForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`orderItemForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`orderItemForm` did not originate from `getOrderItemFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateOrderItems
Description	Tests if this user can update `OrderItems`. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `OrderItem` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may not wish to offer update operations to unauthorized users.
Return	`boolean`		`false` if `OrderItem` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getOrderItemFormForUpdate
Description	Gets the order item form for updating an existing order item. A new order item form should be requested for each update transaction.
Parameters	`osid.id.Id`	`orderItemId`	the `Id` of the `OrderItem`
Return	`osid.ordering.OrderItemForm`		the order item form
Errors	NOT_FOUND		`orderItemId` is not found
	NULL_ARGUMENT		`orderItemId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateOrderItem
Description	Updates an existing order item.
Parameters	`osid.ordering.OrderItemForm`	`orderItemForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`orderItemForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`orderItemForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`orderItemForm` did not originate from `getOrderItemFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteOrderItems
Description	Tests if this user can delete `OrderItems` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `OrderItem` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may not wish to offer delete operations to unauthorized users.
Return	`boolean`		`false` if `OrderItem` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteOrderItem
Description	Deletes an `OrderItem`.
Parameters	`osid.id.Id`	`orderItemId`	the `Id` of the `OrderItem` to remove
Errors	NOT_FOUND		`orderItemId` not found
	NULL_ARGUMENT		`orderItemId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageOrderItemAliases
Description	Tests if this user can manage `Id` aliases for `OrderItems`. 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 `OrderItem` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasOrderItem
Description	Adds an `Id` to an `OrderItem` for the purpose of creating compatibility. The primary `Id` of the `OrderItem` is determined by the provider. The new `Id` performs as an alias to the primary `Id`. If the alias is a pointer to another order item, it is reassigned to the given order item `Id`.
Parameters	`osid.id.Id`	`orderItemId`	the `Id` of an `OrderItem`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`orderItemId` not found
	NULL_ARGUMENT		`orderItemId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.