OSID - osid.financials.AccountAdminSession Service Interface Definition

Interface	osid.financials.AccountAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Accounts.` 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 `Account,` an `AccountForm` is requested using `getAccountFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `AccountForm` 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 `AccountForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `AccountForm` corresponds to an attempted transaction. For updates, `AccountForms` are requested to the `Account` `Id` that is to be updated using `getAccountFormForUpdate().` Similarly, the `AccountForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `AccountForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Accounts.` To unmap an `Account` from the current `Business,` the `AccountBusinessAssignmentSession` should be used. These delete operations attempt to remove the `Account` 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.financials.Business`		the business
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateAccounts
Description	Tests if this user can create `Accounts.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an `Account` 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 `Account` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateAccountWithRecordTypes
Description	Tests if this user can create a single `Account` using the desired record types. While `FinancialsManager.getAccountRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Account.` Providing an empty array tests if an `Account` can be created with no records.
Parameters	`osid.type.Type[]`	`accountRecordTypes`	array of account record types
Return	`boolean`		`true` if `Account` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`accountRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAccountFormForCreate
Description	Gets the account form for creating new accounts. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`accountRecordTypes`	array of account record types
Return	`osid.financials.AccountForm`		the account form
Errors	NULL_ARGUMENT		`accountRecordTypes` 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	createAccount
Description	Creates a new `Account.`
Parameters	`osid.financials.AccountForm`	`accountForm`	the form for this `Account`
Return	`osid.financials.Account`		the new `Account`
Errors	ILLEGAL_STATE		`accountForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`accountForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`accountForm` did not originate from `getAccountFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateAccounts
Description	Tests if this user can update `Accounts.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `Account` 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 `Account` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAccountFormForUpdate
Description	Gets the account form for updating an existing account. A new account form should be requested for each update transaction.
Parameters	`osid.id.Id`	`accountId`	the `Id` of the `Account`
Return	`osid.financials.AccountForm`		the account form
Errors	NOT_FOUND		`accountId` is not found
	NULL_ARGUMENT		`accountId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateAccount
Description	Updates an existing account.
Parameters	`osid.financials.AccountForm`	`accountForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`accountForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`accountForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`accountForm` did not originate from `getAccountFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteAccounts
Description	Tests if this user can delete `Accounts.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `Account` 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 `Account` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteAccount
Description	Deletes an `Account.`
Parameters	`osid.id.Id`	`accountId`	the `Id` of the `Account` to remove
Errors	NOT_FOUND		`accountId` not found
	NULL_ARGUMENT		`accountId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageAccountAliases
Description	Tests if this user can manage `Id` aliases for `Accounts.` 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 `Account` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasAccount
Description	Adds an `Id` to an `Account` for the purpose of creating compatibility. The primary `Id` of the `Account` is deactivityined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another account, it is reassigned to the given account `Id.`
Parameters	`osid.id.Id`	`accountId`	the `Id` of an `Account`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is in use as a primary `Id`
	NOT_FOUND		`accountId` not found
	NULL_ARGUMENT		`accountId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.