org.kuali.kfs.coa.service
Interface AccountService

All Known Implementing Classes:

AccountServiceImpl

public interface AccountService

This interface defines methods that an Account Service must provide

Method Summary

boolean	accountsCanCrossCharts() Returns true if parameter ACCOUNTS_CAN_CROSS_CHARTS_IND is set to "Y"; otherwise false.
Collection<Account>	getAccountsForAccountNumber(String accountNumber) Returns the accounts associated with a given account number
List	getAccountsThatUserIsResponsibleFor(org.kuali.rice.kim.bo.Person kualiUser) Fetches the accounts that the user is either the fiscal officer or fiscal officer delegate for.
Iterator<Account>	getActiveAccountsForAccountSupervisor(String principalId) Retrieves all active accounts from the database where the given principal is the account supervisor
Iterator<Account>	getActiveAccountsForFiscalOfficer(String principalId) Retrieves all active accounts from the database where the given principal is the fiscal officer
Iterator	getAllAccounts() get all accounts in the system.
Account	getByPrimaryId(String chartOfAccountsCode, String accountNumber) Retrieves an Account object based on primary key.
Account	getByPrimaryIdWithCaching(String chartOfAccountsCode, String accountNumber) Method is used by KualiAccountAttribute to enable caching of orgs for routing.
Iterator<Account>	getExpiredAccountsForAccountSupervisor(String principalId) Retrieves all active accounts from the database where the given principal is the account supervisor
Iterator<Account>	getExpiredAccountsForFiscalOfficer(String principalId) Retrieves all expired accounts from the database where the given principal is the fiscal officer
AccountDelegate	getPrimaryDelegationByExample(AccountDelegate delegateExample, String totalDollarAmount) This method retrieves the fiscal officers primary delegate based on the chart, account, and document type specified on the example, along with the total dollar amount
List	getSecondaryDelegationsByExample(AccountDelegate delegateExample, String totalDollarAmount) This method retrieves the fiscal officers secondary delegates based on the chart, account, and document type specified on the example, along with the total dollar amount
Account	getUniqueAccountForAccountNumber(String accountNumber) Returns the unique account associated with a given account number.
boolean	hasResponsibilityOnAccount(org.kuali.rice.kim.bo.Person kualiUser, Account account) Does the given user have responsibilities on the given account?
boolean	isPrincipalInAnyWayShapeOrFormAccountManager(String principalId) Determines if the given principal is the account manager of any non-closed account
boolean	isPrincipalInAnyWayShapeOrFormAccountSupervisor(String principalId) Determines if the given principal is the account supervisor of any non-closed account
boolean	isPrincipalInAnyWayShapeOrFormFiscalOfficer(String principalId) Determines if the given principal is the fiscal officer of any non-closed account
void	populateAccountingLineChartIfNeeded(AccountingLine line)

Method Detail

getByPrimaryId

Account getByPrimaryId(String chartOfAccountsCode,
                       String accountNumber)

Retrieves an Account object based on primary key.

Parameters:

chartOfAccountsCode - - Chart of Accounts Code

accountNumber - - Account Number

Returns:

Account

getByPrimaryIdWithCaching

Account getByPrimaryIdWithCaching(String chartOfAccountsCode,
                                  String accountNumber)

Method is used by KualiAccountAttribute to enable caching of orgs for routing.

See Also:

getByPrimaryId(java.lang.String, java.lang.String)

getPrimaryDelegationByExample

AccountDelegate getPrimaryDelegationByExample(AccountDelegate delegateExample,
                                              String totalDollarAmount)

This method retrieves the fiscal officers primary delegate based on the chart, account, and document type specified on the example, along with the total dollar amount

Parameters:

delegateExample - The object that contains the chart, account, and document type that should be used to query the account delegate table

totalDollarAmount - The amount that should be compared to the from and to amount on the account delegate table

Returns:

The primary delegate for this account, document type, and amount

getSecondaryDelegationsByExample

List getSecondaryDelegationsByExample(AccountDelegate delegateExample,
                                      String totalDollarAmount)

This method retrieves the fiscal officers secondary delegates based on the chart, account, and document type specified on the example, along with the total dollar amount

Parameters:

delegateExample - The object that contains the chart, account, and document type that should be used to query the account delegate table

totalDollarAmount - The amount that should be compared to the from and to amount on the account delegate table

Returns:

The primary delegate for this account, document type, and amount

getAccountsThatUserIsResponsibleFor

List getAccountsThatUserIsResponsibleFor(org.kuali.rice.kim.bo.Person kualiUser)

Fetches the accounts that the user is either the fiscal officer or fiscal officer delegate for.

Parameters:

kualiUser -

Returns:

a list of Accounts that the user has responsibility for

hasResponsibilityOnAccount

boolean hasResponsibilityOnAccount(org.kuali.rice.kim.bo.Person kualiUser,
                                   Account account)

Does the given user have responsibilities on the given account?

Parameters:

kualiUser - the universal user to check responsibilities for

account - the account to check responsibilities on

Returns:

true if user does have responsibilities, false if otherwise

getAllAccounts

Iterator getAllAccounts()

get all accounts in the system. This is needed by a sufficient funds rebuilder job

Returns:

iterator of all accounts

getActiveAccountsForFiscalOfficer

Iterator<Account> getActiveAccountsForFiscalOfficer(String principalId)

Retrieves all active accounts from the database where the given principal is the fiscal officer

Parameters:

principalId - the principal id of the fiscal officer

Returns:

an Iterator of active Accounts

getExpiredAccountsForFiscalOfficer

Iterator<Account> getExpiredAccountsForFiscalOfficer(String principalId)

Retrieves all expired accounts from the database where the given principal is the fiscal officer

Parameters:

principalId - the principal id of the fiscal officer

Returns:

an Iterator of expired Accounts

getActiveAccountsForAccountSupervisor

Iterator<Account> getActiveAccountsForAccountSupervisor(String principalId)

Retrieves all active accounts from the database where the given principal is the account supervisor

Parameters:

principalId - the principal id of the account supervisor

Returns:

an Iterator of active Accounts

getExpiredAccountsForAccountSupervisor

Iterator<Account> getExpiredAccountsForAccountSupervisor(String principalId)

Retrieves all active accounts from the database where the given principal is the account supervisor

Parameters:

principalId - the principal id of the account supervisor

Returns:

an Iterator of expired Accounts

isPrincipalInAnyWayShapeOrFormFiscalOfficer

boolean isPrincipalInAnyWayShapeOrFormFiscalOfficer(String principalId)

Determines if the given principal is the fiscal officer of any non-closed account

Parameters:

principalId - the principal to check for the fiscal officer role

Returns:

true if the principal is a fiscal officer for any non-closed account, false otherwise

isPrincipalInAnyWayShapeOrFormAccountSupervisor

boolean isPrincipalInAnyWayShapeOrFormAccountSupervisor(String principalId)

Determines if the given principal is the account supervisor of any non-closed account

Parameters:

principalId - the principal to check for the account supervisor role

Returns:

true if the principal is a account supervisor for any non-closed account, false otherwise

isPrincipalInAnyWayShapeOrFormAccountManager

boolean isPrincipalInAnyWayShapeOrFormAccountManager(String principalId)

Determines if the given principal is the account manager of any non-closed account

Parameters:

principalId - the principal to check for the account manager role

Returns:

true if the principal is a account manager for any non-closed account, false otherwise

getAccountsForAccountNumber

Collection<Account> getAccountsForAccountNumber(String accountNumber)

Returns the accounts associated with a given account number

Parameters:

accountNumber - the account number

Returns:

a list of accounts associated with that account number

getUniqueAccountForAccountNumber

Account getUniqueAccountForAccountNumber(String accountNumber)

Returns the unique account associated with a given account number. This method only applies when parameter ACCOUNTS_CAN_CROSS_CHARTS_IND is set to "N".

Parameters:

accountNumber - the account number

Returns:

the unique account associated with that account number

accountsCanCrossCharts

boolean accountsCanCrossCharts()

Returns true if parameter ACCOUNTS_CAN_CROSS_CHARTS_IND is set to "Y"; otherwise false.

populateAccountingLineChartIfNeeded

void populateAccountingLineChartIfNeeded(AccountingLine line)