org.kuali.kfs.sys.document.service
Interface AccountingLineRuleHelperService

All Known Subinterfaces:

PurapAccountingLineRuleHelperService

All Known Implementing Classes:

AccountingLineRuleHelperServiceImpl, BudgetAdjustmentAccountingLineRuleHelperServiceImpl, PaymentRequestAccountingLineRuleHelperServiceImpl, PurapAccountingLineRuleHelperServiceImpl, PurchasingAccountingLineRuleHelperServiceImpl, VendorCreditMemoAccountingLineRuleHelperServiceImpl

public interface AccountingLineRuleHelperService

Method Summary

String	getAccountLabel()
String	getChartLabel()
String	getFundGroupCodeLabel()
String	getObjectCodeLabel()
String	getObjectSubTypeCodeLabel()
String	getObjectTypeCodeLabel()
String	getOrganizationCodeLabel()
String	getProjectCodeLabel()
String	getSubAccountLabel()
String	getSubFundGroupCodeLabel()
String	getSubObjectCodeLabel()
boolean	hasRequiredOverrides(AccountingLine line, String overrideCode) Checks that the given overrideCode is sufficient for the given BO, adding errors to the global map if not.
boolean	isValidAccount(Account account, org.kuali.rice.kns.datadictionary.DataDictionary dataDictionary) This method validates that the account is active for use in the system.
boolean	isValidAccount(Account account, org.kuali.rice.kns.datadictionary.DataDictionary dataDictionary, String errorPropertyName) This method validates that the account is active for use in the system.
boolean	isValidChart(Chart chart, org.kuali.rice.kns.datadictionary.DataDictionary dataDictionary) This method validates that the chart is active for use in the system.
boolean	isValidChart(Chart chart, org.kuali.rice.kns.datadictionary.DataDictionary dataDictionary, String errorPropertyName) This method validates that the chart is active for use in the system.
boolean	isValidObjectCode(ObjectCode objectCode, org.kuali.rice.kns.datadictionary.DataDictionary dataDictionary) This method validates that an object code is active.
boolean	isValidObjectCode(ObjectCode objectCode, org.kuali.rice.kns.datadictionary.DataDictionary dataDictionary, String errorPropertyName) This method validates that an object code is active.
boolean	isValidObjectTypeCode(ObjectType objectTypeCode, org.kuali.rice.kns.datadictionary.DataDictionary dataDictionary) For the most part, object type codes aren't required on an accounting line; however, in some situations (e.g.
boolean	isValidObjectTypeCode(ObjectType objectTypeCode, org.kuali.rice.kns.datadictionary.DataDictionary dataDictionary, String errorPropertyName) For the most part, object type codes aren't required on an accounting line; however, in some situations (e.g.
boolean	isValidProjectCode(ProjectCode projectCode, org.kuali.rice.kns.datadictionary.DataDictionary dataDictionary) This method validates that a project code is active.
boolean	isValidProjectCode(ProjectCode projectCode, org.kuali.rice.kns.datadictionary.DataDictionary dataDictionary, String errorPropertyName) This method validates that a project code is active.
boolean	isValidSubAccount(SubAccount subAccount, org.kuali.rice.kns.datadictionary.DataDictionary dataDictionary) This method validates that a sub account is active.
boolean	isValidSubAccount(SubAccount subAccount, org.kuali.rice.kns.datadictionary.DataDictionary dataDictionary, String errorPropertyName) This method validates that a sub account is active.
boolean	isValidSubObjectCode(SubObjectCode subObjectCode, org.kuali.rice.kns.datadictionary.DataDictionary dataDictionary) This method validates that a sub object code is active.
boolean	isValidSubObjectCode(SubObjectCode subObjectCode, org.kuali.rice.kns.datadictionary.DataDictionary dataDictionary, String errorPropertyName) This method validates that a sub object code is active.
boolean	validateAccountingLine(AccountingLine accountingLine) This method validates that an accounting line object contains values that actually exist in the DB.

Method Detail

validateAccountingLine

boolean validateAccountingLine(AccountingLine accountingLine)

This method validates that an accounting line object contains values that actually exist in the DB. SubAccount and SubObject are only checked if there are values in them. The others throw errors if they area null.

Parameters:

accountingLine -

Returns:

success or failure of validating the AccountingLine

Throws:

IllegalStateException

isValidChart

boolean isValidChart(Chart chart,
                     org.kuali.rice.kns.datadictionary.DataDictionary dataDictionary)

This method validates that the chart is active for use in the system.

Parameters:

chart -

dataDictionary -

Returns:

boolean True if the Chart is valid.

isValidChart

boolean isValidChart(Chart chart,
                     org.kuali.rice.kns.datadictionary.DataDictionary dataDictionary,
                     String errorPropertyName)

This method validates that the chart is active for use in the system.

Parameters:

chart -

dataDictionary -

errorPropertyName -

Returns:

boolean True if the Chart is valid.

isValidAccount

boolean isValidAccount(Account account,
                       org.kuali.rice.kns.datadictionary.DataDictionary dataDictionary)

This method validates that the account is active for use in the system.

Parameters:

account -

dataDictionary -

Returns:

boolean True if it is valid.

isValidAccount

boolean isValidAccount(Account account,
                       org.kuali.rice.kns.datadictionary.DataDictionary dataDictionary,
                       String errorPropertyName)

This method validates that the account is active for use in the system.

Parameters:

account -

dataDictionary -

errorPropertyName -

Returns:

boolean True if it is valid.

hasRequiredOverrides

boolean hasRequiredOverrides(AccountingLine line,
                             String overrideCode)

Checks that the given overrideCode is sufficient for the given BO, adding errors to the global map if not.

Parameters:

line -

overrideCode -

Returns:

whether the given overrideCode is sufficient for the given BO.

isValidSubAccount

boolean isValidSubAccount(SubAccount subAccount,
                          org.kuali.rice.kns.datadictionary.DataDictionary dataDictionary)

This method validates that a sub account is active.

Parameters:

subAccount -

dataDictionary -

Returns:

true if it exists

isValidSubAccount

boolean isValidSubAccount(SubAccount subAccount,
                          org.kuali.rice.kns.datadictionary.DataDictionary dataDictionary,
                          String errorPropertyName)

This method validates that a sub account is active.

Parameters:

subAccount -

dataDictionary -

errorPropertyName -

Returns:

true if it exists

isValidObjectCode

boolean isValidObjectCode(ObjectCode objectCode,
                          org.kuali.rice.kns.datadictionary.DataDictionary dataDictionary)

This method validates that an object code is active.

Parameters:

objectCode -

dataDictionary -

Returns:

boolean True if the object code is valid.

isValidObjectCode

boolean isValidObjectCode(ObjectCode objectCode,
                          org.kuali.rice.kns.datadictionary.DataDictionary dataDictionary,
                          String errorPropertyName)

This method validates that an object code is active.

Parameters:

objectCode -

dataDictionary -

errorPropertyName -

Returns:

boolean True if the object code is valid.

isValidSubObjectCode

boolean isValidSubObjectCode(SubObjectCode subObjectCode,
                             org.kuali.rice.kns.datadictionary.DataDictionary dataDictionary)

This method validates that a sub object code is active.

Parameters:

subObjectCode -

dataDictionary -

Returns:

boolean True if it is valid.

isValidSubObjectCode

boolean isValidSubObjectCode(SubObjectCode subObjectCode,
                             org.kuali.rice.kns.datadictionary.DataDictionary dataDictionary,
                             String errorPropertyName)

This method validates that a sub object code is active.

Parameters:

subObjectCode -

dataDictionary -

errorPropertyName -

Returns:

boolean True if it is valid.

isValidProjectCode

boolean isValidProjectCode(ProjectCode projectCode,
                           org.kuali.rice.kns.datadictionary.DataDictionary dataDictionary)

This method validates that a project code is active.

Parameters:

projectCode -

dataDictionary -

Returns:

boolean True if it is valid.

isValidProjectCode

boolean isValidProjectCode(ProjectCode projectCode,
                           org.kuali.rice.kns.datadictionary.DataDictionary dataDictionary,
                           String errorPropertyName)

This method validates that a project code is active.

Parameters:

projectCode -

dataDictionary -

errorPropertyName -

Returns:

boolean True if it is valid.

isValidObjectTypeCode

boolean isValidObjectTypeCode(ObjectType objectTypeCode,
                              org.kuali.rice.kns.datadictionary.DataDictionary dataDictionary)

For the most part, object type codes aren't required on an accounting line; however, in some situations (e.g. Journal Voucher) they are entered directly into the accounting line and must be validated. In those cases, they must be validated for activeness.

Parameters:

objectTypeCode -

dataDictionary -

Returns:

boolean True if the object type code is valid, false otherwise.

isValidObjectTypeCode

boolean isValidObjectTypeCode(ObjectType objectTypeCode,
                              org.kuali.rice.kns.datadictionary.DataDictionary dataDictionary,
                              String errorPropertyName)

For the most part, object type codes aren't required on an accounting line; however, in some situations (e.g. Journal Voucher) they are entered directly into the accounting line and must be validated. In those cases, they must be validated for activeness.

Parameters:

objectTypeCode -

dataDictionary -

errorPropertyName -

Returns:

boolean True if the object type code is valid, false otherwise.

getChartLabel

String getChartLabel()

Returns:

short label for chart code defined in data dictionary

getAccountLabel

String getAccountLabel()

Returns:

short label for account number defined in data dictionary

getSubAccountLabel

String getSubAccountLabel()

Returns:

short label for sub account number defined in data dictionary

getObjectCodeLabel

String getObjectCodeLabel()

Returns:

short label for object code defined in data dictionary

getSubObjectCodeLabel

String getSubObjectCodeLabel()

Returns:

short label for sub object code defined in data dictionary

getProjectCodeLabel

String getProjectCodeLabel()

Returns:

short label for project code defined in data dictionary

getObjectTypeCodeLabel

String getObjectTypeCodeLabel()

Returns:

short label for object type code defined in data dictionary

getObjectSubTypeCodeLabel

String getObjectSubTypeCodeLabel()

Returns:

short label for object sub type code defined in data dictionary

getOrganizationCodeLabel

String getOrganizationCodeLabel()

Returns:

short label for organization code defined in data dictionary

getFundGroupCodeLabel

String getFundGroupCodeLabel()

Returns:

short label for fund group code defined in data dictionary

getSubFundGroupCodeLabel

String getSubFundGroupCodeLabel()

Returns:

short label for sub fund group code defined in data dictionary