Interface | osid.financials.budgeting.BudgetEntryLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for retrieving This session defines views that offer differing behaviors when retrieving multiple objects.
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 | ||
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 | canLookupBudgetEntries | ||
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 | useComparativeBudgetEntryView | ||
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 | usePlenaryBudgetEntryView | ||
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 budget entries in businesses which are children of this business 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 lookups to this business only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useEffectiveBudgetEntryView | ||
Description |
Only budget entries whose effective dates are current are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useAnyEffectiveBudgetEntryView | ||
Description |
All budget entries of any effective dates are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getBudgetEntry | ||
Description |
Gets the In effective mode, budget entries are returned that are currently effective. In any effective mode, effective budget entries and those currently expired are returned. | ||
Parameters | osid.id.Id | budgetEntryId | Id of the BudgetEntry |
Return | osid.financials.budgeting.BudgetEntry | the entry | |
Errors | NOT_FOUND | budgetEntryId not found | |
NULL_ARGUMENT | budgetEntryId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getBudgetEntriesByIds | ||
Description |
Gets an In effective mode, budget entries are returned that are currently effective. In any effective mode, effective budget entries and those currently expired are returned. | ||
Parameters | osid.id.IdList | budgetEntryIds | the list of Ids to retrieve |
Return | osid.financials.budgeting.BudgetEntryList | the returned BudgetEntry list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | budgetEntryIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBudgetEntriesByGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | entryGenusType | a budget entry genus type |
Return | osid.financials.budgeting.BudgetEntryList | the returned BudgetEntry list | |
Errors | NULL_ARGUMENT | entryGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBudgetEntriesByParentGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | entryGenusType | a budget entry genus type |
Return | osid.financials.budgeting.BudgetEntryList | the returned BudgetEntry list | |
Errors | NULL_ARGUMENT | entryGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBudgetEntriesByRecordType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | budgetEntryRecordType | a budget entry record type |
Return | osid.financials.budgeting.BudgetEntryList | the returned BudgetEntry list | |
Errors | NULL_ARGUMENT | budgetEntryRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBudgetEntriesOnDate | ||
Description |
Gets a 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. | ||
Parameters | osid.calendaring.DateTime | from | start of date range |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.financials.budgeting.BudgetEntryList | the returned BudgetEntryList | |
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 | getBudgetEntriesForBudget | ||
Description |
Gets a | ||
Parameters | osid.id.Id | budgetId | a budget Id |
Return | osid.financials.budgeting.BudgetEntryList | the returned BudgetEntry list | |
Errors | NULL_ARGUMENT | budgetId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBudgetEntriesForBudgetOnDate | ||
Description |
Gets a 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. | ||
Parameters | osid.id.Id | budgetId | a budget Id |
osid.calendaring.DateTime | from | start of date range | |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.financials.budgeting.BudgetEntryList | the returned BudgetEntryList | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | budgetId, from or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBudgetEntriesForAccount | ||
Description |
Gets a | ||
Parameters | osid.id.Id | accountId | an account Id |
Return | osid.financials.budgeting.BudgetEntryList | the returned BudgetEntry list | |
Errors | NULL_ARGUMENT | accountId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBudgetEntriesForAccountOnDate | ||
Description |
Gets a 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. | ||
Parameters | osid.id.Id | accountId | an account Id |
osid.calendaring.DateTime | from | start of date range | |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.financials.budgeting.BudgetEntryList | the returned BudgetEntryList | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | accountId, from or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBudgetEntriesForBudgetAndAccount | ||
Description |
Gets a | ||
Parameters | osid.id.Id | budgetId | a budget Id |
osid.id.Id | accountId | an account Id | |
Return | osid.financials.budgeting.BudgetEntryList | the returned BudgetEntry list | |
Errors | NULL_ARGUMENT | budgetId or accountId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBudgetEntriesForBudgetAndAccountOnDate | ||
Description |
Gets a 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. | ||
Parameters | osid.id.Id | budgetId | a budget Id |
osid.id.Id | accountId | an account Id | |
osid.calendaring.DateTime | from | start of date range | |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.financials.budgeting.BudgetEntryList | the returned BudgetEntryList | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | budgetId, accountId, from or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBudgetEntries | ||
Description |
Gets all 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. | ||
Return | osid.financials.budgeting.BudgetEntryList | a list of BudgetEntries | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |