Interface AccountLookupSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface AccountLookupSession extends OsidSession

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.

Like all OsidSessions, AccountLookupSessions are dedicated to single processing threads and a single authenticated user.

  • Method Details

    • getBusinessId

      Id getBusinessId()
      Gets the Business Id associated with this session.
      Returns:
      the Business Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getBusiness

      Business getBusiness() throws OperationFailedException, PermissionDeniedException
      Gets the Business associated with this session.
      Returns:
      the business
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canLookupAccounts

      boolean canLookupAccounts()
      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.
      Returns:
      false if lookup methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeAccountView

      void useComparativeAccountView()
      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 must be implemented.

    • usePlenaryAccountView

      void usePlenaryAccountView()
      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.
      Compliance:
      mandatory - This method must be implemented.

    • useFederatedBusinessView

      void useFederatedBusinessView()
      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 must be implemented.

    • useIsolatedBusinessView

      void useIsolatedBusinessView()
      Isolates the view for methods in this session. An isolated view restricts retrievals to this business only.
      Compliance:
      mandatory - This method must be implemented.

    • getAccount

      Account getAccount(Id accountId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      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.
      Parameters:
      accountId - the Id of the Account to retrieve
      Returns:
      the returned Account
      Throws:
      NotFoundException - no Account found with the given Id
      NullArgumentException - accountId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAccountsByIds

      AccountList getAccountsByIds(IdList accountIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      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.
      Parameters:
      accountIds - the list of Ids to retrieve
      Returns:
      the returned Account list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - accountIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAccountsByGenusType

      AccountList getAccountsByGenusType(Type accountGenusType) throws OperationFailedException, PermissionDeniedException
      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.
      Parameters:
      accountGenusType - an account genus type
      Returns:
      the returned Account list
      Throws:
      NullArgumentException - accountGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAccountsByParentGenusType

      AccountList getAccountsByParentGenusType(Type accountGenusType) throws OperationFailedException, PermissionDeniedException
      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.
      Parameters:
      accountGenusType - an account genus type
      Returns:
      the returned Account list
      Throws:
      NullArgumentException - accountGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAccountsByRecordType

      AccountList getAccountsByRecordType(Type accountRecordType) throws OperationFailedException, PermissionDeniedException
      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.
      Parameters:
      accountRecordType - an account record type
      Returns:
      the returned Account list
      Throws:
      NullArgumentException - accountRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAccountsByCode

      AccountList getAccountsByCode(String code) throws OperationFailedException, PermissionDeniedException
      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.
      Parameters:
      code - n account code
      Returns:
      the returned Account list
      Throws:
      NullArgumentException - code is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAccounts

      AccountList getAccounts() throws OperationFailedException, PermissionDeniedException
      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.
      Returns:
      a list of Accounts
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.