OSID - osid.financials.BusinessAdminSession Service Interface Definition

Interface	osid.financials.BusinessAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.financials.batch.BusinessBatchAdminSession`
Used By	`osid.financials.FinancialsManager`
Used By	`osid.financials.FinancialsProxyManager`
Description	This session creates, updates, and deletes `Businesses`. The data for create and update is provided by the consumer via the form. `OsidForms` are requested for each create or update and may not be reused. Create and update operations differ in their usage. To create a `Business`, a `BusinessForm` is requested using `getBusinessFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `BusinessForm` 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 `BusinessForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `BusinessForm` corresponds to an attempted transaction. For updates, `BusinessForms` are requested to the `Business` `Id` that is to be updated using `getBusinessFormForUpdate()`. Similarly, the `BusinessForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `BusinessForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Businesses`. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	canCreateBusinesses
Description	Tests if this user can create `Businesses`. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Business`. 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 `Business` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateBusinessWithRecordTypes
Description	Tests if this user can create a single `Business` using the desired record types. While `FinancialsManager.getBusinessRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Business`. Providing an empty array tests if a `Business` can be created with no records.
Parameters	`osid.type.Type[]`	`businessRecordTypes`	array of business record types
Return	`boolean`		`true` if `Business` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`businessRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getBusinessFormForCreate
Description	Gets the business form for creating new businesses. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`businessRecordTypes`	array of business record types
Return	`osid.financials.BusinessForm`		the business form
Errors	NULL_ARGUMENT		`businessRecordTypes` 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	createBusiness
Description	Creates a new `Business`.
Parameters	`osid.financials.BusinessForm`	`businessForm`	the form for this `Business`
Return	`osid.financials.Business`		the new `Business`
Errors	ILLEGAL_STATE		`businessForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`businessForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`businessForm` did not originate from `getBusinessFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateBusinesses
Description	Tests if this user can update `Businesses`. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Business` 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 `Business` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getBusinessFormForUpdate
Description	Gets the business form for updating an existing business. A new business form should be requested for each update transaction.
Parameters	`osid.id.Id`	`businessId`	the `Id` of the `Business`
Return	`osid.financials.BusinessForm`		the business form
Errors	NOT_FOUND		`businessId` is not found
	NULL_ARGUMENT		`businessId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateBusiness
Description	Updates an existing business.
Parameters	`osid.financials.BusinessForm`	`businessForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`businessForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`businessForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`businessForm` did not originate from `getBusinessFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteBusinesses
Description	Tests if this user can delete `Businesses`. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Business` 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 `Business` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteBusiness
Description	Deletes a `Business`.
Parameters	`osid.id.Id`	`businessId`	the `Id` of the `Business` to remove
Errors	NOT_FOUND		`businessId` not found
	NULL_ARGUMENT		`businessId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageBusinessAliases
Description	Tests if this user can manage `Id` aliases for `Businesses`. 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 `Business` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasBusiness
Description	Adds an `Id` to a `Business` for the purpose of creating compatibility. The primary `Id` of the `Business` is determined by the provider. The new `Id` performs as an alias to the primary `Id`. If the alias is a pointer to another business, it is reassigned to the given business `Id`.
Parameters	`osid.id.Id`	`businessId`	the `Id` of a `Business`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`aliasId` is in use as a primary `Id`
	NULL_ARGUMENT		`businessId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.