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

This session provides methods to re-assign BudgetEntries to Business objects An BudgetEntry may appear in multiple Business objects 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
CompliancemandatoryThis 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.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 entry 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.
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.IdbusinessIdthe Id of the Business
osid.id.IdbudgetEntryIdthe Id of the BudgetEntry
Returnosid.id.IdListlist of assignable business Ids
ErrorsNULL_ARGUMENT businessId or budgetEntryId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignBudgetEntryToBusiness
Description

Adds an existing BudgetEntry to a Business.

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

Removes an BudgetEntry from a Business.

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

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

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