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

Interface	osid.financials.budgeting.BudgetEntryAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.financials.budgeting.batch.BudgetEntryBatchAdminSession`
Used By	`osid.financials.budgeting.FinancialsBudgetingManager`
Used By	`osid.financials.budgeting.FinancialsBudgetingProxyManager`
Description	This session creates, updates, and deletes `BudgetEntries`. 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 an `BudgetEntry`, an `BudgetEntryForm` is requested using `getBudgetEntryFormForCreate()` specifying the desired budget, account period, and record `Types` or none if no record `Types` are needed. The returned `BudgetEntryForm` 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 `BudgetEntryForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `BudgetEntryForm` corresponds to an attempted transaction. For updates, `BudgetEntryForms` are requested to the `BudgetEntry` `Id` that is to be updated using `getBudgetEntryFormForUpdate()`. Similarly, the `BudgetEntryForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `BudgetEntryForm` can only be used once for a successful update and cannot be reused. The delete operations delete `BudgetEntryForms` . To unmap an `BudgetEntry` from the current `Business`, the `BudgetEntryBusinessAssignmentSession` should be used. These delete operations attempt to remove the `BudgetEntryForm` 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	canCreateBudgetEntries
Description	Tests if this user can create `BudgetEntries`. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an `BudgetEntry` 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 `BudgetEntry` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateBudgetEntryWithRecordTypes
Description	Tests if this user can create a single `BudgetEntry` using the desired record types. While `FinancialsBudgetManager.getBudgetEntryRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `BudgetEntry`. Providing an empty array tests if an `BudgetEntry` can be created with no records.
Parameters	`osid.type.Type[]`	`budgetEntryRecordTypes`	array of budget entry record types
Return	`boolean`		`true` if `BudgetEntry` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`budgetEntryRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getBudgetEntryFormForCreate
Description	Gets the budget entry form for creating new budget entries. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`budgetId`	a budget `Id`
	`osid.id.Id`	`accountId`	an account `Id`
	`osid.type.Type[]`	`budgetEntryRecordTypes`	array of budget entry record types
Return	`osid.financials.budgeting.BudgetEntryForm`		the budget entry form
Errors	NOT_FOUND		`budgetId` or `accountId` is not found
	NULL_ARGUMENT		`budgetId, accountId`, or `budgetEntryRecordTypes` 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	createBudgetEntry
Description	Creates a new `BudgetEntry`.
Parameters	`osid.financials.budgeting.BudgetEntryForm`	`entryForm`	the form for this `BudgetEntry`
Return	`osid.financials.budgeting.BudgetEntry`		the new `BudgetEntry`
Errors	ILLEGAL_STATE		`entryForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`entryForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`entryForm` did not originate from `getBudgetEntryFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateBudgetEntries
Description	Tests if this user can update `BudgetEntries`. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `BudgetEntry` 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 `BudgetEntry` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getBudgetEntryFormForUpdate
Description	Gets the budget entry form for updating an existing budget entries. A new budget entry form should be requested for each update transaction.
Parameters	`osid.id.Id`	`budgetEntryId`	the `Id` of the `BudgetEntry`
Return	`osid.financials.budgeting.BudgetEntryForm`		the budget entry form
Errors	NOT_FOUND		`budgetEntryId` is not found
	NULL_ARGUMENT		`budgetEntryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateBudgetEntry
Description	Updates an existing budget entries.
Parameters	`osid.financials.budgeting.BudgetEntryForm`	`budgetEntryForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`budgetEntryForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`budgetEntryForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`entryForm` did not originate from `getBudgetEntryFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteBudgetEntries
Description	Tests if this user can delete `BudgetEntries`. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `BudgetEntry` 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 `BudgetEntry` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteBudgetEntry
Description	Deletes an `BudgetEntry`.
Parameters	`osid.id.Id`	`budgetEntryId`	the `Id` of the `BudgetEntry` to remove
Errors	NOT_FOUND		`budgetEntryId` not found
	NULL_ARGUMENT		`budgetEntryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageBudgetEntryAliases
Description	Tests if this user can manage `Id` aliases for `BudgetEntries`. 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 `BudgetEntry` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasBudgetEntry
Description	Adds an `Id` to an `BudgetEntry` for the purpose of creating compatibility. The primary `Id` of the `BudgetEntry` is deentryined by the provider. The new `Id` performs as an alias to the primary `Id`. If the alias is a pointer to another budget entry, it is reassigned to the given budget entry `Id`.
Parameters	`osid.id.Id`	`budgetEntryId`	the `Id` of an `BudgetEntry`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is in use as a primary `Id`
	NOT_FOUND		`budgetEntryId` not found
	NULL_ARGUMENT		`budgetEntryId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.