OSID - osid.ordering.ProductAdminSession Service Interface Definition

Interface	osid.ordering.ProductAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Products.` 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 `Product,` a `ProductForm` is requested using `getProductFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `ProductForm` 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 `ProductForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `ProductForm` corresponds to an attempted transaction. For updates, `ProductForms` are requested to the `Product` `Id` that is to be updated using `getProductFormForUpdate().` Similarly, the `ProductForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `ProductForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Products.` To unmap a `Product` from the current `Store,` the `ProductStoreAssignmentSession` should be used. These delete operations attempt to remove the `Product` 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	canCreateProducts
Description	Tests if this user can create `Products.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Product` 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 `Product` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateProductWithRecordTypes
Description	Tests if this user can create a single `Product` using the desired record types. While `OrderingManager.getProductRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Product.` Providing an empty array tests if a `Product` can be created with no records.
Parameters	`osid.type.Type[]`	`productRecordTypes`	array of product record types
Return	`boolean`		`true` if `Product` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`productRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getProductFormForCreate
Description	Gets the product form for creating new products. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`productRecordTypes`	array of product record types
Return	`osid.ordering.ProductForm`		the product form
Errors	NULL_ARGUMENT		`productRecordTypes` 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	createProduct
Description	Creates a new `Product.`
Parameters	`osid.ordering.ProductForm`	`productForm`	the form for this `Product`
Return	`osid.ordering.Product`		the new `Product`
Errors	ILLEGAL_STATE		`productForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`productForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`productForm` did not originate from `getProductFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateProducts
Description	Tests if this user can update `Products.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Product` 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 `Product` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getProductFormForUpdate
Description	Gets the product form for updating an existing product. A new product form should be requested for each update transaction.
Parameters	`osid.id.Id`	`productId`	the `Id` of the `Product`
Return	`osid.ordering.ProductForm`		the product form
Errors	NULL_ARGUMENT		`productId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	updateProduct
Description	Updates an existing product.
Parameters	`osid.ordering.ProductForm`	`productForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`productForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`productForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`productForm` did not originate from `getProductFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteProducts
Description	Tests if this user can delete `Products` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Product` 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 `Product` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteProduct
Description	Deletes a `Product.`
Parameters	`osid.id.Id`	`productId`	the `Id` of the `Product` to remove
Errors	NOT_FOUND		`productId` not found
	NULL_ARGUMENT		`productId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageProductAliases
Description	Tests if this user can manage `Id` aliases for `Products.` 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 `Product` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasProduct
Description	Adds an `Id` to a `Product` for the purpose of creating compatibility. The primary `Id` of the `Product` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another product, it is reassigned to the given product `Id.`
Parameters	`osid.id.Id`	`productId`	the `Id` of a `Product`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`productId` not found
	NULL_ARGUMENT		`productId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.