Interface | osid.financials.AccountLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods for retrieving general ledger accounts. This lookup session defines several views:
The methods Accounts 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 | canLookupAccounts | ||
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 | useComparativeAccountView | ||
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 | usePlenaryAccountView | ||
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 accounts 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 | getAccount | ||
Description |
Gets the | ||
Parameters | osid.id.Id | accountId | the Id of the Account to retrieve |
Return | osid.financials.Account | the returned Account | |
Errors | NOT_FOUND | no Account found with the given Id | |
NULL_ARGUMENT | accountId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAccountsByIds | ||
Description |
Gets an | ||
Parameters | osid.id.IdList | accountIds | the list of Ids to retrieve |
Return | osid.financials.AccountList | the returned Account list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | accountIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAccountsByGenusType | ||
Description |
Gets an | ||
Parameters | osid.type.Type | accountGenusType | an account genus type |
Return | osid.financials.AccountList | the returned Account list | |
Errors | NULL_ARGUMENT | accountGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAccountsByParentGenusType | ||
Description |
Gets an | ||
Parameters | osid.type.Type | accountGenusType | an account genus type |
Return | osid.financials.AccountList | the returned Account list | |
Errors | NULL_ARGUMENT | accountGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAccountsByRecordType | ||
Description |
Gets an | ||
Parameters | osid.type.Type | accountRecordType | an account record type |
Return | osid.financials.AccountList | the returned Account list | |
Errors | NULL_ARGUMENT | accountRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAccountsByCode | ||
Description |
Gets an | ||
Parameters | string | code | n account code |
Return | osid.financials.AccountList | the returned Account list | |
Errors | NULL_ARGUMENT | code is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAccounts | ||
Description |
Gets all | ||
Return | osid.financials.AccountList | a list of Accounts | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |