OSID - osid.ordering.OrderAdminSession Service Interface Definition

Interface	osid.ordering.OrderAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.ordering.batch.OrderBatchAdminSession`
Used By	`osid.ordering.OrderingManager`
Used By	`osid.ordering.OrderingProxyManager`
Description	This session creates, updates, and deletes `Orders`. 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 `Order`, an `OrderForm` is requested using `getOrderFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `OrderForm` 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 `OrderForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `OrderForm` corresponds to an attempted transaction. For updates, `OrderForms` are requested to the `Order` `Id` that is to be updated using `getOrderFormForUpdate()`. Similarly, the `OrderForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `OrderForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Orders`. To unmap an `Order` from the current `Store`, the `OrderStoreAssignmentSession` should be used. These delete operations attempt to remove the `Order` 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.
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	canCreateOrders
Description	Tests if this user can create order entries. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an `Order` 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 `Order` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateOrderWithRecordTypes
Description	Tests if this user can create a single `Order` using the desired record types. While `OrderingManager.getOrderRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Order`. Providing an empty array tests if an `Order` can be created with no records.
Parameters	`osid.type.Type[]`	`orderRecordTypes`	array of order record types
Return	`boolean`		`true` if `Order` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`orderRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getOrderFormForCreate
Description	Gets the order form for creating new entries. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`orderRecordTypes`	array of order record types
Return	`osid.ordering.OrderForm`		the order form
Errors	NULL_ARGUMENT		`orderRecordTypes` 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	createOrder
Description	Creates a new `Order`.
Parameters	`osid.ordering.OrderForm`	`orderForm`	the form for this `Order`
Return	`osid.ordering.Order`		the new `Order`
Errors	ILLEGAL_STATE		`orderForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`orderForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`orderForm` did not originate from `getOrderFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateOrders
Description	Tests if this user can update orders. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `Order` 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 `Order` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getOrderFormForUpdate
Description	Gets the order form for updating an existing order. A new order form should be requested for each update transaction.
Parameters	`osid.id.Id`	`orderId`	the `Id` of the `Order`
Return	`osid.ordering.OrderForm`		the order form
Errors	NOT_FOUND		`orderId` is not found
	NULL_ARGUMENT		`orderId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateOrder
Description	Updates an existing order.
Parameters	`osid.ordering.OrderForm`	`orderForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`orderForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`orderForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`orderForm` did not originate from `getOrderFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteOrders
Description	Tests if this user can delete orders. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `Order` 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 `Order` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteOrder
Description	Deletes an `Order`.
Parameters	`osid.id.Id`	`orderId`	the `Id` of the `Order` to remove
Errors	NOT_FOUND		`orderId` not found
	NULL_ARGUMENT		`orderId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageOrderAliases
Description	Tests if this user can manage `Id` aliases for `Orders`. 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 `Order` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasOrder
Description	Adds an `Id` to an `Order` for the purpose of creating compatibility. The primary `Id` of the `Order` 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, it is reassigned to the given order `Id`.
Parameters	`osid.id.Id`	`orderId`	the `Id` of an `Order`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`orderId` not found
	NULL_ARGUMENT		`orderId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.