OSID - osid.ordering.OrderItemStoreAssignmentSession Service Interface Definition

Interface	osid.ordering.OrderItemStoreAssignmentSession
Implements	`osid.OsidSession`
Used By	`osid.ordering.OrderingManager`
Used By	`osid.ordering.OrderingProxyManager`
Description	This session provides methods to re-assign `OrderItems` to `Stores`. A `OrderItem` may map to multiple `Stores` and removing the last reference to an `OrderItem` is the equivalent of deleting it. Each `Store` may have its own authorizations governing who is allowed to operate on it. Adding a reference of a `OrderItem` to another `Store` is not a copy operation (eg: does not change its `Id`). Like all `OsidSessions`, `OrderItemStoreAssignmentSessions` are dedicated to single processing threads and a single authenticated user.
Method	canAssignOrderItems
Description	Tests if this user can alter order item/store mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canAssignOrderItemsToStore
Description	Tests if this user can alter order item/store mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.
Parameters	`osid.id.Id`	`storeId`	the `Id` of the `Store`
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Errors	NULL_ARGUMENT		`storeId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAssignableStoreIds
Description	Gets a list of stores including and under the given store node in which any order item can be assigned.
Parameters	`osid.id.Id`	`storeId`	the `Id` of the `Store`
Return	`osid.id.IdList`		list of assignable store `Ids`
Errors	NULL_ARGUMENT		`storeId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getAssignableStoreIdsForOrderItem
Description	Gets a list of stores including and under the given store node in which a specific order item can be assigned.
Parameters	`osid.id.Id`	`storeId`	the `Id` of the `Store`
Parameters	`osid.id.Id`	`orderItemId`	the `Id` of the `OrderItem`
Return	`osid.id.IdList`		list of assignable store `Ids`
Errors	NULL_ARGUMENT		`storeId` or `orderItemId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	assignOrderItemToStore
Description	Adds an existing `OrderItem` to a `Store`.
Parameters	`osid.id.Id`	`orderItemId`	the `Id` of the `OrderItem`
Parameters	`osid.id.Id`	`storeId`	the `Id` of the `Store`
Errors	ALREADY_EXISTS		`orderItemId` is already assigned to `storeId`
	NOT_FOUND		`orderItemId` or `storeId` not found
	NULL_ARGUMENT		`orderItemId` or `storeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignOrderItemFromStore
Description	Removes an `OrderItem` from a `Store`.
Parameters	`osid.id.Id`	`orderItemId`	the `Id` of the `OrderItem`
Parameters	`osid.id.Id`	`storeId`	the `Id` of the `Store`
Errors	NOT_FOUND		`orderItemId` or `storeId` not found or `orderItemId` not assigned to `storeId`
	NULL_ARGUMENT		`orderItemId` or `storeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	reassignOrderItemToStore
Description	Moves an `OrderItem` from one `Store` to another. Mappings to other `Stores` are unaffected.
Parameters	`osid.id.Id`	`orderItemId`	the `Id` of the `OrderItem`
	`osid.id.Id`	`fromStoreId`	the `Id` of the current `Store`
	`osid.id.Id`	`toStoreId`	the `Id` of the destination `Store`
Errors	ALREADY_EXISTS		`orderItemId` already assigned to `storeId`
	NOT_FOUND		`orderItemId, fromStoreId`, or `toStoreId` not found or `orderItemId` not mapped to `fromStoreId`
	NULL_ARGUMENT		`orderItemId, fromStoreId`, or `toStoreId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.