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

This session defines methods for retrieving general ledger accounts.

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 account methods in this session operate, retrieve and pertain to accounts defined explicitly in the current business. Using an isolated view is useful for managing Accounts with the AccountAdminSession.
  • federated business view: All account lookup methods in this session operate, retrieve and pertain to all accounts defined in this business and any other accounts implicitly available in this business through business inheritence.

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

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

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

Tests if this user can perform Account 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.
MethoduseComparativeAccountView
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.
MethodusePlenaryAccountView
Description

A complete view of the Account 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 accounts 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.
MethodgetAccount
Description

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

Parametersosid.id.IdaccountIdthe Id of the Account to retrieve
Returnosid.financials.Accountthe returned Account
ErrorsNOT_FOUNDno Account found with the given Id
NULL_ARGUMENT accountId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAccountsByIds
Description

Gets an AccountList corresponding to the given IdList. In plenary mode, the returned list contains all of the accounts 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 Accounts may be omitted from the list and may present the elements in any order including returning a unique set.

Parametersosid.id.IdListaccountIdsthe list of Ids to retrieve
Returnosid.financials.AccountListthe returned Account list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT accountIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAccountsByGenusType
Description

Gets an AccountList corresponding to the given account genus Type which does not include accounts of types derived from the specified Type. In plenary mode, the returned list contains all known accounts or an error results. Otherwise, the returned list may contain only those accounts that are accessible through this session.

Parametersosid.type.TypeaccountGenusTypean account genus type
Returnosid.financials.AccountListthe returned Account list
ErrorsNULL_ARGUMENT accountGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAccountsByParentGenusType
Description

Gets an AccountList corresponding to the given account genus Type and include any additional accounts with genus types derived from the specified Type. In plenary mode, the returned list contains all known accounts or an error results. Otherwise, the returned list may contain only those accounts that are accessible through this session.

Parametersosid.type.TypeaccountGenusTypean account genus type
Returnosid.financials.AccountListthe returned Account list
ErrorsNULL_ARGUMENT accountGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAccountsByRecordType
Description

Gets an AccountList containing the given account record Type. In plenary mode, the returned list contains all known accounts or an error results. Otherwise, the returned list may contain only those accounts that are accessible through this session.

Parametersosid.type.TypeaccountRecordTypean account record type
Returnosid.financials.AccountListthe returned Account list
ErrorsNULL_ARGUMENT accountRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAccountsByCode
Description

Gets an AccountList associated with the given code. In plenary mode, the returned list contains all known accounts or an error results. Otherwise, the returned list may contain only those accounts that are accessible through this session.

Parametersstringcoden account code
Returnosid.financials.AccountListthe returned Account list
ErrorsNULL_ARGUMENT code is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAccounts
Description

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

Returnosid.financials.AccountLista list of Accounts
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.