OSID - osid.financials.budgeting.BudgetAdminSession Service Interface Definition

Interface	osid.financials.budgeting.BudgetAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.financials.budgeting.batch.BudgetBatchAdminSession`
Used By	`osid.financials.budgeting.FinancialsBudgetingManager`
Used By	`osid.financials.budgeting.FinancialsBudgetingProxyManager`
Description	This session creates, updates, and deletes `Budgets`. 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 `Budget`, a `BudgetForm` is requested using `getBudgetFormForCreate()` specifying the desired activity, fiscal period, and record `Types` or none if no record `Types` are needed. The returned `BudgetForm` 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 `BudgetForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `BudgetForm` corresponds to an attempted transaction. For updates, `BudgetForms` are requested to the `Budget` `Id` that is to be updated using `getBudgetFormForUpdate()`. Similarly, the `BudgetForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `BudgetForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Budgets`. To unmap a `Budget` from the current `Business`, the `BudgetBusinessAssignmentSession` should be used. These delete operations attempt to remove the `Budget` 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	canCreateBudgets
Description	Tests if this user can create `Budgets`. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Budget` 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 `Budget` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateBudgetWithRecordTypes
Description	Tests if this user can create a single `Budget` using the desired record types. While `FinancialsBudgetManager.getBudgetRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Budget`. Providing an empty array tests if a `Budget` can be created with no records.
Parameters	`osid.type.Type[]`	`budgetRecordTypes`	array of budget record types
Return	`boolean`		`true` if `Budget` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`budgetRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getBudgetFormForCreate
Description	Gets the budget form for creating new budgets. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`activityId`	the Id of the associated `Activity`
	`osid.id.Id`	`fiscalPeriodId`	the Id of the fiscal period
	`osid.type.Type[]`	`budgetRecordTypes`	array of budget record types
Return	`osid.financials.budgeting.BudgetForm`		the budget form
Errors	NOT_FOUND		`activityId` or `fiscalPeriodId` not found
	NULL_ARGUMENT		`activityId, fiscalPeriodId`, or `budgetRecordTypes` 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	createBudget
Description	Creates a new `Budget`.
Parameters	`osid.financials.budgeting.BudgetForm`	`budgetForm`	the form for this `Budget`
Return	`osid.financials.budgeting.Budget`		the new `Budget`
Errors	ILLEGAL_STATE		`budgetForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`budgetForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`entryForm did not originate from getBudgetFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateBudgets
Description	Tests if this user can update `Budgets`. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Budget` 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 `Budget` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getBudgetFormForUpdate
Description	Gets the budget form for updating an existing budget. A new budget form should be requested for each update transaction.
Parameters	`osid.id.Id`	`budgetId`	the `Id` of the `Budget`
Return	`osid.financials.budgeting.BudgetForm`		the budget form
Errors	NOT_FOUND		`budgetId` is not found
	NULL_ARGUMENT		`budgetId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateBudget
Description	Updates an existing budget.
Parameters	`osid.financials.budgeting.BudgetForm`	`budgetForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`budgetForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`budgetForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`entryForm did not originate from getBudgetFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteBudgets
Description	Tests if this user can delete `Budgets`. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Budget` 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 `Budget` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteBudget
Description	Deletes a `Budget`.
Parameters	`osid.id.Id`	`budgetId`	the `Id` of the `Budget` to remove
Errors	NOT_FOUND		`budgetId` not found
	NULL_ARGUMENT		`budgetId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageBudgetAliases
Description	Tests if this user can manage `Id` aliases for `Budgets`. 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 `Budget` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasBudget
Description	Adds an `Id` to a `Budget` for the purpose of creating compatibility. The primary `Id` of the `Budget` is determined by the provider. The new `Id` performs as an alias to the primary `Id`. If the alias is a pointer to another budget, it is reassigned to the given budget `Id`.
Parameters	`osid.id.Id`	`budgetId`	the `Id` of a `Budget`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is in use as a primary `Id`
	NOT_FOUND		`budgetId` not found
	NULL_ARGUMENT		`budgetId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.