Interface | osid.financials.budgeting.BudgetLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods for retrieving budgets. This lookup session defines several views:
The methods Budgets may have an additional records indicated by their
respective record types. The record may not be accessed
through a cast of the | ||
Method | getBusinessId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Business Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getBusiness | ||
Description |
Gets the | ||
Return | osid.financials.Business | the business | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canLookupBudgets | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if lookup methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeBudgetView | ||
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. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryBudgetView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedBusinessView | ||
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. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedBusinessView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts retrievals to this business only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useEffectiveBudgetView | ||
Description |
Only budgets whose effective dates are current are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useAnyEffectiveBudgetView | ||
Description |
All budgets of any effective dates are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getBudget | ||
Description |
Gets the In effective mode, budgets are returned that are currently effective. In any effective mode, effective budgets and those currently expired are returned. | ||
Parameters | osid.id.Id | budgetId | the Id of the Budget to retrieve |
Return | osid.financials.budgeting.Budget | the returned Budget | |
Errors | NOT_FOUND | no Budget found with the given Id | |
NULL_ARGUMENT | budgetId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBudgetsByIds | ||
Description |
Gets a In effective mode, budgets are returned that are currently effective. In any effective mode, effective budgets and those currently expired are returned. | ||
Parameters | osid.id.IdList | budgetIds | the list of Ids to retrieve |
Return | osid.financials.budgeting.BudgetList | the returned Budget list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | budgetIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBudgetsByGenusType | ||
Description |
Gets a In effective mode, budgets are returned that are currently effective. In any effective mode, effective budgets and those currently expired are returned. | ||
Parameters | osid.type.Type | budgetGenusType | a budget genus type |
Return | osid.financials.budgeting.BudgetList | the returned Budget list | |
Errors | NULL_ARGUMENT | budgetGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBudgetsByParentGenusType | ||
Description |
Gets a In effective mode, budgets are returned that are currently effective. In any effective mode, effective budgets and those currently expired are returned. | ||
Parameters | osid.type.Type | budgetGenusType | a budget genus type |
Return | osid.financials.budgeting.BudgetList | the returned Budget list | |
Errors | NULL_ARGUMENT | budgetGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBudgetsByRecordType | ||
Description |
Gets a 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. | ||
Parameters | osid.type.Type | budgetRecordType | a budget record type |
Return | osid.financials.budgeting.BudgetList | the returned Budget list | |
Errors | NULL_ARGUMENT | budgetRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBudgetsOnDate | ||
Description |
Gets a 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. | ||
Parameters | osid.calendaring.DateTime | from | start of date range |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.financials.budgeting.BudgetList | the returned Budget list | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | from or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBudgetsForActivity | ||
Description |
Gets a 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. | ||
Parameters | osid.id.Id | activityId | an activity Id |
Return | osid.financials.budgeting.BudgetList | the returned Budget list | |
Errors | NULL_ARGUMENT | activityId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBudgetsForActivityOnDate | ||
Description |
Gets a 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. | ||
Parameters | osid.id.Id | activityId | an activity Id |
osid.calendaring.DateTime | from | start of date range | |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.financials.budgeting.BudgetList | the returned Budget list | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | activityId, from or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBudgetsForFiscalPeriod | ||
Description |
Gets a 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. | ||
Parameters | osid.id.Id | fiscalPeriodId | a fiscal period Id |
Return | osid.financials.budgeting.BudgetList | the returned Budget list | |
Errors | NULL_ARGUMENT | fiscalPeriodId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBudgetsForFiscalPeriodOnDate | ||
Description |
Gets a 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. | ||
Parameters | osid.id.Id | fiscalPeriodId | a fiscal period Id |
osid.calendaring.DateTime | from | start of date range | |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.financials.budgeting.BudgetList | the returned Budget list | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | fiscalPeriodId, from or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBudgetsForActivityAndFiscalPeriod | ||
Description |
Gets a 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. | ||
Parameters | osid.id.Id | activityId | an activity Id |
osid.id.Id | fiscalPeriodId | a fiscal period Id | |
Return | osid.financials.budgeting.BudgetList | the returned Budget list | |
Errors | NULL_ARGUMENT | activityId or fiscalPeriodId is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBudgetsForActivityAndFiscalPeriodOnDate | ||
Description |
Gets a 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. | ||
Parameters | osid.id.Id | activityId | an activity Id |
osid.id.Id | fiscalPeriodId | a fiscal period Id | |
osid.calendaring.DateTime | from | start of date range | |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.financials.budgeting.BudgetList | the returned Budget list | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | activityId, fiscalPeriodId, from or to is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBudgets | ||
Description |
Gets all 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. | ||
Return | osid.financials.budgeting.BudgetList | a list of Budgets | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |