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

This session provides methods for retrieving BudgetEntry objects.

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition
  • isolated business view: All budget entry methods in this session operate, retrieve and pertain to budget entries defined explicitly in the current business. Using an isolated view is useful for managing BudgetEntries with the BudgetEntryAdminSession.
  • federated business view: All budget entry methods in this session operate, retrieve and pertain to all budget entries defined in this business and any other budget entries implicitly available in this business through business inheritence.
  • effective budget entry view: All budget entry lookup methods return budget entries where the current date falls in between the effective dates inclusive.
  • any effective budget entry view: Budget entries of any effective date are returned from methods.

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods useFederatedBusinessView() and useIsolatedBusinessView() behave as a radio group and one should be selected before invoking any lookup methods.

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.
MethodcanLookupBudgetEntries
Description

Tests if this user can perform BudgetEntry 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 opt not to offer lookup operations to unauthorized users.

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

A complete view of the BudgetEntry 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 budget entries in businesses which are children of this business in the business hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedBusinessView
Description

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

CompliancemandatoryThis method is must be implemented.
MethoduseEffectiveBudgetEntryView
Description

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

CompliancemandatoryThis method is must be implemented.
MethoduseAnyEffectiveBudgetEntryView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodgetBudgetEntry
Description

Gets the BudgetEntry specified by its Id.

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

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

Parametersosid.id.IdbudgetEntryId Id of the BudgetEntry
Returnosid.financials.budgeting.BudgetEntrythe entry
ErrorsNOT_FOUND budgetEntryId not found
NULL_ARGUMENT budgetEntryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetBudgetEntriesByIds
Description

Gets an BudgetEntryList corresponding to the given IdList.

In plenary mode, the returned list contains all of the budget entries 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 BudgetEntries may be omitted from the list and may present the elements in any order including returning a unique set.

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

Parametersosid.id.IdListbudgetEntryIdsthe list of Ids to retrieve
Returnosid.financials.budgeting.BudgetEntryListthe returned BudgetEntry list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT budgetEntryIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBudgetEntriesByGenusType
Description

Gets a BudgetEntryList corresponding to the given budget entry genus Type which does not include budget entries of genus types derived from the specified Type.

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

Parametersosid.type.TypeentryGenusTypea budget entry genus type
Returnosid.financials.budgeting.BudgetEntryListthe returned BudgetEntry list
ErrorsNULL_ARGUMENT entryGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBudgetEntriesByParentGenusType
Description

Gets a BudgetEntryList corresponding to the given budget entry genus Type and include any additional budget entries with genus types derived from the specified Type.

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

Parametersosid.type.TypeentryGenusTypea budget entry genus type
Returnosid.financials.budgeting.BudgetEntryListthe returned BudgetEntry list
ErrorsNULL_ARGUMENT entryGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBudgetEntriesByRecordType
Description

Gets a BudgetEntryList containing the given budget entry record Type.

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

Parametersosid.type.TypebudgetEntryRecordTypea budget entry record type
Returnosid.financials.budgeting.BudgetEntryListthe returned BudgetEntry list
ErrorsNULL_ARGUMENT budgetEntryRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBudgetEntriesOnDate
Description

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

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

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

Parametersosid.calendaring.DateTimefromstart of date range
osid.calendaring.DateTimetoend of date range
Returnosid.financials.budgeting.BudgetEntryListthe returned BudgetEntryList
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.
MethodgetBudgetEntriesForBudget
Description

Gets a BudgetEntryList for the given budget.

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

Parametersosid.id.IdbudgetIda budget Id
Returnosid.financials.budgeting.BudgetEntryListthe returned BudgetEntry list
ErrorsNULL_ARGUMENT budgetId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBudgetEntriesForBudgetOnDate
Description

Gets a BudgetEntryList for the given budget 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 budget entries or an error results. Otherwise, the returned list may contain only those budget entries that are accessible through this session.

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

Parametersosid.id.IdbudgetIda budget Id
osid.calendaring.DateTimefromstart of date range
osid.calendaring.DateTimetoend of date range
Returnosid.financials.budgeting.BudgetEntryListthe returned BudgetEntryList
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT budgetId, from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBudgetEntriesForAccount
Description

Gets a BudgetEntryList for the given account.

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

Parametersosid.id.IdaccountIdan account Id
Returnosid.financials.budgeting.BudgetEntryListthe returned BudgetEntry list
ErrorsNULL_ARGUMENT accountId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBudgetEntriesForAccountOnDate
Description

Gets a BudgetEntryList for the given account 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 budget entries or an error results. Otherwise, the returned list may contain only those budget entries that are accessible through this session.

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

Parametersosid.id.IdaccountIdan account Id
osid.calendaring.DateTimefromstart of date range
osid.calendaring.DateTimetoend of date range
Returnosid.financials.budgeting.BudgetEntryListthe returned BudgetEntryList
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT accountId, from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBudgetEntriesForBudgetAndAccount
Description

Gets a BudgetEntryList for the given budget and account.

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

Parametersosid.id.IdbudgetIda budget Id
osid.id.IdaccountIdan account Id
Returnosid.financials.budgeting.BudgetEntryListthe returned BudgetEntry list
ErrorsNULL_ARGUMENT budgetId or accountId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBudgetEntriesForBudgetAndAccountOnDate
Description

Gets a BudgetEntryList for the given budget, account, 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 budget entries or an error results. Otherwise, the returned list may contain only those budget entries that are accessible through this session.

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

Parametersosid.id.IdbudgetIda budget Id
osid.id.IdaccountIdan account Id
osid.calendaring.DateTimefromstart of date range
osid.calendaring.DateTimetoend of date range
Returnosid.financials.budgeting.BudgetEntryListthe returned BudgetEntryList
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT budgetId, accountId, from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBudgetEntries
Description

Gets all BudgetEntries.

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

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