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

This session provides methods to retrieve BudgetEntry to Business mappings. An BudgetEntry may appear in multiple Business objects. Each catalog may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
MethodcanLookupBudgetEntryBusinessMappings
Description

Tests if this user can perform lookups of entry/business mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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.

Returnboolean false if looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeBudgetEntryBusinessView
Description

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryBudgetEntryBusinessView
Description

A complete view of the BudgetEntry and Business returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethodgetBudgetEntryIdsByBusiness
Description

Gets the list of BudgetEntry Ids associated with a Business.

Parametersosid.id.IdbusinessId Id of the Business
Returnosid.id.IdListlist of related budget entry Ids
ErrorsNOT_FOUND businessId is not found
NULL_ARGUMENT businessId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetActivitieByBusiness
Description

Gets the list of BudgetEntry associated with a Business.

Parametersosid.id.IdbusinessId Id of the Business
Returnosid.financials.budgeting.BudgetEntryListlist of related entries
ErrorsNOT_FOUND businessId is not found
NULL_ARGUMENT businessId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBudgetEntryIdsByBusinesses
Description

Gets the list of BudgetEntry Ids corresponding to a list of Business objects.

Parametersosid.id.IdListbusinessIdslist of catalog Ids
Returnosid.id.IdListlist of budget entry Ids
ErrorsNULL_ARGUMENT businessIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetActivitieByBusinesses
Description

Gets the list of BudgetEntries corresponding to a list of Business objects.

Parametersosid.id.IdListbusinessIdslist of catalog Ids
Returnosid.financials.budgeting.BudgetEntryListlist of entries
ErrorsNULL_ARGUMENT businessIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBusinessIdsByBudgetEntry
Description

Gets the Business Ids mapped to an BudgetEntry.

Parametersosid.id.IdbudgetEntryId Id of an BudgetEntry
Returnosid.id.IdListlist of businesses
ErrorsNOT_FOUND budgetEntryId is not found
NULL_ARGUMENT budgetEntryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBusinessesByBudgetEntry
Description

Gets the Business objects mapped to an BudgetEntry.

Parametersosid.id.IdbudgetEntryId Id of an BudgetEntry
Returnosid.financials.BusinessListlist of businesses
ErrorsNOT_FOUND budgetEntryId is not found
NULL_ARGUMENT budgetEntryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.