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

This session provides methods to re-assign BudgetEntries to Businesses. An BudgetEntry may appear in multiple Businesses and removing the last reference to an BudgetEntry 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 an BudgetEntry to another Business is not a copy operation (eg: does not change its Id).

MethodcanAssignBudgetEntries
Description

Tests if this user can alter entry/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.
MethodcanAssignBudgetEntriesToBusiness
Description

Tests if this user can alter entry/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 entry 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.
MethodgetAssignableBusinessIdsForBudgetEntry
Description

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

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

Adds an existing BudgetEntry to a Business.

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

Removes an BudgetEntry from a Business.

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

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

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