OSID Logo
OSID Specifications
financials budgeting package
Version 3.1.0
Interfaceosid.financials.budgeting.BudgetBusinessAssignmentSession
Implementsosid.OsidSession
Used Byosid.financials.budgeting.FinancialsBudgetingManager
osid.financials.budgeting.FinancialsBudgetingProxyManager
Description

This session provides methods to re-assign Budgets to Businesses. A Budget may appear in multiple Businesses and removing the last reference to a Budget is the equivalent of deleting it. Each Business may have its own authorizations governing who is allowed to operate on it.

Adding a reference of a Budget to another Business is not a copy operation (eg: does not change its Id).

MethodcanAssignBudgets
Description

Tests if this user can alter budget/business mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.

Returnboolean false if mapping is not authorized, true otherwise
Compliancemandatory This method must be implemented.
MethodcanAssignBudgetToBusiness
Description

Tests if this user can alter budget/business mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Parametersosid.id.IdbusinessId the Id of the Business
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT businessId is null
Compliancemandatory This method must be implemented.
MethodgetAssignableBusinessIds
Description

Gets a list of businesses including and under the given business node in which any budget can be assigned.

Parametersosid.id.IdbusinessId the Id of the Business
Returnosid.id.IdList list of assignable business Ids
ErrorsNULL_ARGUMENT businessId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetAssignableBusinessIdsForBudget
Description

Gets a list of businesses including and under the given business node in which a specific budget can be assigned.

Parametersosid.id.IdbusinessId the Id of the Business
osid.id.IdbudgetId the Id of the Budget
Returnosid.id.IdList list of assignable business Ids
ErrorsNULL_ARGUMENT businessId or budgetId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodassignBudgetToBusiness
Description

Adds an existing Budget to a Business.

Parametersosid.id.IdbudgetId the Id of the Budget
osid.id.IdbusinessId the Id of the Business
ErrorsALREADY_EXISTS budgetId is already assigned to businessId
NOT_FOUND budgetId or businessId not found
NULL_ARGUMENT budgetId or businessId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodunassignBudgetFromBusiness
Description

Removes a Budget from a Business.

Parametersosid.id.IdbudgetId the Id of the Budget
osid.id.IdbusinessId the Id of the Business
ErrorsNOT_FOUND budgetId or businessId not found or budgetId not assigned to businessId
NULL_ARGUMENT budgetId or businessId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodreassignBudgetToBusiness
Description

Moves a Budget from one Business to another. Mappings to other Businesses are unaffected.

Parametersosid.id.IdbudgetId the Id of the Budget
osid.id.IdfromBusinessId the Id of the current Business
osid.id.IdtoBusinessId the Id of the destination Business
ErrorsALREADY_EXISTS budgetId already assigned to toBusinessId
NOT_FOUND budgetId, fromBusinessId, or toBusinessId not found or budgetId not mapped to fromBusinessId
NULL_ARGUMENT budgetId, fromBusinessId, or toBusinessId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.