OSID Logo
OSID Specifications
financials budgeting package
Version 3.0.0
Release Candidate Preview
Interfaceosid.financials.budgeting.BudgetBusinessAssignmentSession
Implementsosid.OsidSession
Description

This session provides methods to re-assign Budgets to Business objects A Budget may appear in multiple Business objects 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
CompliancemandatoryThis 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.IdbusinessIdthe Id of the Business
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT businessId is null
CompliancemandatoryThis 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.IdbusinessIdthe Id of the Business
Returnosid.id.IdListlist of assignable business Ids
ErrorsNULL_ARGUMENT businessId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis 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.IdbusinessIdthe Id of the Business
osid.id.IdbudgetIdthe Id of the Budget
Returnosid.id.IdListlist of assignable business Ids
ErrorsNULL_ARGUMENT businessId or budgetId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignBudgetToBusiness
Description

Adds an existing Budget to a Business.

Parametersosid.id.IdbudgetIdthe Id of the Budget
osid.id.IdbusinessIdthe 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_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignBudgetFromBusiness
Description

Removes a Budget from a Business.

Parametersosid.id.IdbudgetIdthe Id of the Budget
osid.id.IdbusinessIdthe 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_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignBudgetToBusiness
Description

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

Parametersosid.id.IdbudgetIdthe Id of the Budget
osid.id.IdfromBusinessIdthe Id of the current Business
osid.id.IdtoBusinessIdthe Id of the destination Business
ErrorsNOT_FOUND budgetId, fromBusinessId, or toBusinessId not found or budgetId not mapped to fromBusinessId
NULL_ARGUMENT budgetId, fromBusinessId, or toBusinessId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.