OSID - osid.billing.CategoryAdminSession Service Interface Definition

Interface	osid.billing.CategoryAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.billing.batch.CategoryBatchAdminSession`
Used By	`osid.billing.BillingManager`
Used By	`osid.billing.BillingProxyManager`
Description	This session creates, updates, and deletes `Categories`. 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 `Category`, a `CategoryForm` is requested using `getCategoryFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `CategoryForm` 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 `CategoryForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `CategoryForm` corresponds to an attempted transaction. For updates, `CategoryForms` are requested to the `Category` `Id` that is to be updated using `getCategoryFormForUpdate()`. Similarly, the `CategoryForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `CategoryForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Categories`. To unmap a `Category` from the current `Business`, the `CategoryBusinessAssignmentSession` should be used. These delete operations attempt to remove the `Category` itself thus removing it from all known `Business` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getBusinessId
Description	Gets the `Business` `Id` associated with this session.
Return	`osid.id.Id`		the `Business Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getBusiness
Description	Gets the `Business` associated with this session.
Return	`osid.billing.Business`		the business
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateCategories
Description	Tests if this user can create `Categories`. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Category` 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 `Category` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateCategoryWithRecordTypes
Description	Tests if this user can create a single `Category` using the desired record types. While `BillingManager.getCategoryRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Category`. Providing an empty array tests if a `Category` can be created with no records.
Parameters	`osid.type.Type[]`	`categoryRecordTypes`	array of category record types
Return	`boolean`		`true` if `Category` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`categoryRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCategoryFormForCreate
Description	Gets the category form for creating new categories. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`categoryRecordTypes`	array of category record types
Return	`osid.billing.CategoryForm`		the category form
Errors	NULL_ARGUMENT		`categoryRecordTypes` 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	createCategory
Description	Creates a new `Category`.
Parameters	`osid.billing.CategoryForm`	`categoryForm`	the form for this `Category`
Return	`osid.billing.Category`		the new `Category`
Errors	ILLEGAL_STATE		`categoryForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`categoryForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`entryForm did not originate from getCategoryFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateCategories
Description	Tests if this user can update `Categories`. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Category` 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 `Category` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCategoryFormForUpdate
Description	Gets the category form for updating an existing category. A new category form should be requested for each update transaction.
Parameters	`osid.id.Id`	`categoryId`	the `Id` of the `Category`
Return	`osid.billing.CategoryForm`		the category form
Errors	NOT_FOUND		`categoryId` is not found
	NULL_ARGUMENT		`categoryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateCategory
Description	Updates an existing category.
Parameters	`osid.billing.CategoryForm`	`categoryForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`categoryForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`categoryForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`entryForm did not originate from getCategoryFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteCategories
Description	Tests if this user can delete `Categories`. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Category` 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 `Category` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteCategory
Description	Deletes a `Category`.
Parameters	`osid.id.Id`	`categoryId`	the `Id` of the `Category` to remove
Errors	NOT_FOUND		`categoryId` not found
	NULL_ARGUMENT		`categoryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageCategoryAliases
Description	Tests if this user can manage `Id` aliases for `Categories`. 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 `Category` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasCategory
Description	Adds an `Id` to a `Category` for the purpose of creating compatibility. The primary `Id` of the `Customer` is determined by the provider. The new `Id` performs as an alias to the primary `Id`. If the alias is a pointer to another category, it is reassigned to the given category `Id`.
Parameters	`osid.id.Id`	`categoryId`	the `Id` of a `Category`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is in use as a primary `Id`
	NOT_FOUND		`categoryId` not found
	NULL_ARGUMENT		`categoryId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.