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

This session defines methods for retrieving budgets.

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
  • isolated business view: All budget methods in this session operate, retrieve and pertain to budgets defined explicitly in the current business. Using an isolated view is useful for managing Budgets with the BudgetAdminSession.
  • federated business view: All budget lookup methods in this session operate, retrieve and pertain to all budgets defined in this business and any other budgets implicitly available in this business through business inheritence.
  • effective budget view: All budget lookup methods return budgets where the current date falls in between the effective dates inclusive.
  • any effective budget view: Budgets of any effective date are returned from methods.

The methods useFederatedBusinessView() and useIsolatedBusinessView() behave as a radio group and one should be selected before invoking any lookup methods.

Budgets may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the Budget.

MethodgetBusinessId
Description

Gets the Business Id associated with this session.

Returnosid.id.Idthe Business Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetBusiness
Description

Gets the Business associated with this session.

Returnosid.financials.Businessthe business
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupBudgets
Description

Tests if this user can perform Budget lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeBudgetView
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.
MethodusePlenaryBudgetView
Description

A complete view of the Budget 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.
MethoduseFederatedBusinessView
Description

Federates the view for methods in this session. A federated view will include budgets in catalogs which are children of this catalog in the business hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedBusinessView
Description

Isolates the view for methods in this session. An isolated view restricts retrievals to this business only.

CompliancemandatoryThis method is must be implemented.
MethoduseEffectiveBudgetView
Description

Only budgets whose effective dates are current are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethoduseAnyEffectiveBudgetView
Description

All budgets of any effective dates are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethodgetBudget
Description

Gets the Budget specified by its Id.

In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Budget may have a different Id than requested, such as the case where a duplicate Id was assigned to a Budget and retained for compatibility.

In effective mode, budgets are returned that are currently effective. In any effective mode, effective budgets and those currently expired are returned.

Parametersosid.id.IdbudgetIdthe Id of the Budget to retrieve
Returnosid.financials.budgeting.Budgetthe returned Budget
ErrorsNOT_FOUNDno Budget found with the given Id
NULL_ARGUMENT budgetId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBudgetsByIds
Description

Gets a BudgetList corresponding to the given IdList.

In plenary mode, the returned list contains all of the budgets specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Budgets may be omitted from the list and may present the elements in any order including returning a unique set.

In effective mode, budgets are returned that are currently effective. In any effective mode, effective budgets and those currently expired are returned.

Parametersosid.id.IdListbudgetIdsthe list of Ids to retrieve
Returnosid.financials.budgeting.BudgetListthe returned Budget list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT budgetIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBudgetsByGenusType
Description

Gets a BudgetList corresponding to the given budget genus Type which does not include budgets of types derived from the specified Type.

In plenary mode, the returned list contains all known budgets or an error results. Otherwise, the returned list may contain only those budgets that are accessible through this session.

In effective mode, budgets are returned that are currently effective. In any effective mode, effective budgets and those currently expired are returned.

Parametersosid.type.TypebudgetGenusTypea budget genus type
Returnosid.financials.budgeting.BudgetListthe returned Budget list
ErrorsNULL_ARGUMENT budgetGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBudgetsByParentGenusType
Description

Gets a BudgetList corresponding to the given budget genus Type and include any additional budgets with genus types derived from the specified Type.

In plenary mode, the returned list contains all known budgets or an error results. Otherwise, the returned list may contain only those budgets that are accessible through this session.

In effective mode, budgets are returned that are currently effective. In any effective mode, effective budgets and those currently expired are returned.

Parametersosid.type.TypebudgetGenusTypea budget genus type
Returnosid.financials.budgeting.BudgetListthe returned Budget list
ErrorsNULL_ARGUMENT budgetGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBudgetsByRecordType
Description

Gets a BudgetList containing the given budget record Type.

In plenary mode, the returned list contains all known mode,s or an error results. Otherwise, the returned list may contain only those budgets that are accessible through this session.

In effective mode, budgets are returned that are currently effective. In any effective mode, effective budgets and those currently expired are returned.

Parametersosid.type.TypebudgetRecordTypea budget record type
Returnosid.financials.budgeting.BudgetListthe returned Budget list
ErrorsNULL_ARGUMENT budgetRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBudgetsOnDate
Description

Gets a BudgetList effective during the entire given date range inclusive but not confined to the date range.

In plenary mode, the returned list contains all known budgets or an error results. Otherwise, the returned list may contain only those budgets that are accessible through this session.

In effective mode, budgets are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective budgets and those currently expired are returned.

Parametersosid.calendaring.DateTimefromstart of date range
osid.calendaring.DateTimetoend of date range
Returnosid.financials.budgeting.BudgetListthe returned Budget list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBudgetsForActivity
Description

Gets a BudgetList for the given activity.

In plenary mode, the returned list contains all known mode,s or an error results. Otherwise, the returned list may contain only those budgets that are accessible through this session.

In effective mode, budgets are returned that are currently effective. In any effective mode, effective budgets and those currently expired are returned.

Parametersosid.id.IdactivityIdan activity Id
Returnosid.financials.budgeting.BudgetListthe returned Budget list
ErrorsNULL_ARGUMENT activityId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBudgetsForActivityOnDate
Description

Gets a BudgetList for the given activity and effective during the entire given date range inclusive but not confined to the date range.

In plenary mode, the returned list contains all known budgets or an error results. Otherwise, the returned list may contain only those budgets that are accessible through this session.

In effective mode, budgets are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective budgets and those currently expired are returned.

Parametersosid.id.IdactivityIdan activity Id
osid.calendaring.DateTimefromstart of date range
osid.calendaring.DateTimetoend of date range
Returnosid.financials.budgeting.BudgetListthe returned Budget list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT activityId, from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBudgetsForFiscalPeriod
Description

Gets a BudgetList for the given fiscal period.

In plenary mode, the returned list contains all known mode,s or an error results. Otherwise, the returned list may contain only those budgets that are accessible through this session.

In effective mode, budgets are returned that are currently effective. In any effective mode, effective budgets and those currently expired are returned.

Parametersosid.id.IdfiscalPeriodIda fiscal period Id
Returnosid.financials.budgeting.BudgetListthe returned Budget list
ErrorsNULL_ARGUMENT fiscalPeriodId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBudgetsForFiscalPeriodOnDate
Description

Gets a BudgetList for the given fiscal period and effective during the entire given date range inclusive but not confined to the date range.

In plenary mode, the returned list contains all known budgets or an error results. Otherwise, the returned list may contain only those budgets that are accessible through this session.

In effective mode, budgets are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective budgets and those currently expired are returned.

Parametersosid.id.IdfiscalPeriodIda fiscal period Id
osid.calendaring.DateTimefromstart of date range
osid.calendaring.DateTimetoend of date range
Returnosid.financials.budgeting.BudgetListthe returned Budget list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT fiscalPeriodId, from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBudgetsForActivityAndFiscalPeriod
Description

Gets a BudgetList for the given activity and fiscal period.

In plenary mode, the returned list contains all known mode,s or an error results. Otherwise, the returned list may contain only those budgets that are accessible through this session.

In effective mode, budgets are returned that are currently effective. In any effective mode, effective budgets and those currently expired are returned.

Parametersosid.id.IdactivityIdan activity Id
osid.id.IdfiscalPeriodIda fiscal period Id
Returnosid.financials.budgeting.BudgetListthe returned Budget list
ErrorsNULL_ARGUMENT activityId or fiscalPeriodId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBudgetsForActivityAndFiscalPeriodOnDate
Description

Gets a BudgetList for the given activity, fiscal period, and effective during the entire given date range inclusive but not confined to the date range.

In plenary mode, the returned list contains all known budgets or an error results. Otherwise, the returned list may contain only those budgets that are accessible through this session.

In effective mode, budgets are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective budgets and those currently expired are returned.

Parametersosid.id.IdactivityIdan activity Id
osid.id.IdfiscalPeriodIda fiscal period Id
osid.calendaring.DateTimefromstart of date range
osid.calendaring.DateTimetoend of date range
Returnosid.financials.budgeting.BudgetListthe returned Budget list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT activityId, fiscalPeriodId, from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBudgets
Description

Gets all Budgets.

In plenary mode, the returned list contains all known budgets or an error results. Otherwise, the returned list may contain only those budgets that are accessible through this session.

In effective mode, budgets are returned that are currently effective. In any effective mode, effective budgets and those currently expired are returned.

Returnosid.financials.budgeting.BudgetLista list of Budgets
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.