org.kuali.kfs.coa.service
Interface AccountPersistenceStructureService

All Superinterfaces:

org.kuali.rice.kns.service.PersistenceStructureService

All Known Implementing Classes:

AccountPersistenceStructureServiceImpl

public interface AccountPersistenceStructureService
extends org.kuali.rice.kns.service.PersistenceStructureService

Provides facilities to obtain chartofAccountsCode-accountNumber foreign key fields and the corresponding account or account-involved reference objects.

Method Summary

String	getAccountNumberName(org.kuali.rice.kns.bo.PersistableBusinessObject bo, String chartOfAccountsCodeFieldName) Gets the name of the accountNumber field as one foreign key, paired with the specified chartOfAccountsCode field as the other, of the reference account (or other account-involved BO) contained within the specified parent object.
String	getChartOfAccountsCodeName(org.kuali.rice.kns.bo.PersistableBusinessObject bo, String accountNumberFieldName) Gets the name of the chartOfAccountsCode field as one foreign key, paired with the specified accountNumber field as the other, of the reference account (or other account-involved BO) contained within the specified parent object.
boolean	isAccountRelatedClass(Class clazz) Decides if the specified class is an account related class, i.e.
Map<String,String>	listAccountNumberChartCodePairs(org.kuali.rice.kns.bo.PersistableBusinessObject bo) Determines the list of accountNumber-chartOfAccountsCode pairs as (part of) the foreign keys of the reference accounts (or other account-involved BOs) contained within the specified parent object.
Set<String>	listAccountNumberNames(org.kuali.rice.kns.bo.PersistableBusinessObject bo) Determines the list of accountNumber fields as one of the foreign keys of the reference accounts (or other account-involved BOs) contained within the specified parent object.
Map<String,String>	listChartCodeAccountNumberPairs(org.kuali.rice.kns.bo.PersistableBusinessObject bo) Determines the list of chartOfAccountsCode-accountNumber pairs as (part of) the foreign keys of the reference accounts (or other account-involved BOs) contained within the specified parent object.
Set<String>	listChartOfAccountsCodeNames(org.kuali.rice.kns.bo.PersistableBusinessObject bo) Determines the list of chartOfAccountsCode fields as one of the foreign keys of the reference accounts (or other account-involved BOs) contained within the specified parent object.
Map<String,Class>	listCollectionAccountFields(org.kuali.rice.kns.bo.PersistableBusinessObject bo) Determines the list of collection accounts (or other account-involved BOs) contained within the specified parent object.
Set<String>	listCollectionChartOfAccountsCodeNames(org.kuali.rice.kns.bo.PersistableBusinessObject bo) Determines the list of chartOfAccountsCode fields as one of the primary keys in the collection accounts (or other account-involved BOs) contained within the specified parent object.
Map<String,Class>	listReferenceAccountFields(org.kuali.rice.kns.bo.PersistableBusinessObject bo) Determines the list of reference accounts (or other account-involved BOs) contained within the specified parent object.

Methods inherited from interface org.kuali.rice.kns.service.PersistenceStructureService

clearPrimaryKeyFields, getBusinessObjectAttributeClass, getForeignKeyFieldName, getForeignKeyFieldsPopulationState, getForeignKeysForReference, getInverseForeignKeysForCollection, getNestedForeignKeyMap, getPrimaryKeys, getReferencesForForeignKey, getRelationshipMetadata, getRelationshipMetadata, getTableName, hasCollection, hasPrimaryKeyFieldValues, hasReference, isCollectionUpdatable, isPersistable, isReferenceUpdatable, listCollectionObjectTypes, listCollectionObjectTypes, listFieldNames, listPersistableSubclasses, listPrimaryKeyFieldNames, listReferenceObjectFields, listReferenceObjectFields

Method Detail

isAccountRelatedClass

boolean isAccountRelatedClass(Class clazz)

Decides if the specified class is an account related class, i.e. whether it contains chartOfAccountsCode and accountNumber as part of the primary keys.

Parameters:

clazz - the specified class

Returns:

true if the class contains chartOfAccountsCode and accountNumber as part of the primary keys; false otherwise.

listCollectionAccountFields

Map<String,Class> listCollectionAccountFields(org.kuali.rice.kns.bo.PersistableBusinessObject bo)

Determines the list of collection accounts (or other account-involved BOs) contained within the specified parent object. For example, an Award object contains awardAccounts. Note: these do not include the following cases - nested collection accounts - non-maintainable collection accounts

Parameters:

bo - BusinessObject (or subclass) instance that would like to be analyzed for collection accounts.

Returns:

Map containing the collection account names (key) and class type (value) or empty map if the BO contains no collection accounts.

listCollectionChartOfAccountsCodeNames

Set<String> listCollectionChartOfAccountsCodeNames(org.kuali.rice.kns.bo.PersistableBusinessObject bo)

Determines the list of chartOfAccountsCode fields as one of the primary keys in the collection accounts (or other account-involved BOs) contained within the specified parent object. For example, an Award object contains awardAccounts with chartOfAccountsCode as one of the primary keys. Note: these do not include the following cases - nested collection accounts - non-maintainable collection accounts

Parameters:

bo - BusinessObject (or subclass) instance that would like to be analyzed for collection accounts.

Returns:

Set containing the chartOfAccountsCode field names in collection accounts or empty set if the BO contains no collection accounts.

listReferenceAccountFields

Map<String,Class> listReferenceAccountFields(org.kuali.rice.kns.bo.PersistableBusinessObject bo)

Determines the list of reference accounts (or other account-involved BOs) contained within the specified parent object. For example, an Account object contains reportsToAccount etc. Note: these do not include the following cases: - nested reference accounts - reference accounts in collections - reference accounts whose PKs are also PKs of the BO - reference accounts whose PKs don't exist in the BO as foreign keys but are referred by the maintenance page in a nested way - non-existing reference accounts whose PKs exist in the BO as foreign keys (this should never happen) - non-maintainable reference accounts

Parameters:

bo - BusinessObject (or subclass) instance that would like to be analyzed for reference accounts.

Returns:

Map containing the reference account names (key) and class type (value) or empty map if the BO contains no reference accounts.

listChartCodeAccountNumberPairs

Map<String,String> listChartCodeAccountNumberPairs(org.kuali.rice.kns.bo.PersistableBusinessObject bo)

Determines the list of chartOfAccountsCode-accountNumber pairs as (part of) the foreign keys of the reference accounts (or other account-involved BOs) contained within the specified parent object. For example, an Account object contains reportsToAccount with reportsToChartOfAccountsCode-reportsToAccountNumber as the foreign keys. Note: these do not include the following cases: - nested reference accounts - reference accounts in collections - reference accounts whose PKs are also PKs of the BO - reference accounts whose PKs don't exist in the BO as foreign keys but are referred by the maintainance page in a nested way - non-existing reference accounts whose PKs exist in the BO as foreign keys (this should never happen) - non-maintainable reference accounts

Parameters:

bo - BusinessObject (or subclass) instance that would like to be analyzed for reference accounts.

Returns:

Map containing the chartOfAccountsCode-accountNumber (key-value) foreign key pairs for all reference accounts or empty map if the BO contains no reference accounts.

listAccountNumberChartCodePairs

Map<String,String> listAccountNumberChartCodePairs(org.kuali.rice.kns.bo.PersistableBusinessObject bo)

Determines the list of accountNumber-chartOfAccountsCode pairs as (part of) the foreign keys of the reference accounts (or other account-involved BOs) contained within the specified parent object. For example, an Account object contains reportsToAccount with reportsToAccountNumber-reportsToChartOfAccountsCode as the foreign keys. Note: these do not include the following cases: - nested reference accounts - reference accounts in collections - reference accounts whose PKs are also PKs of the BO - reference accounts whose PKs don't exist in the BO as foreign keys but are referred by the maintainance page in a nested way - non-existing reference accounts whose PKs exist in the BO as foreign keys (this should never happen) - non-maintainable reference accounts

Parameters:

bo - BusinessObject (or subclass) instance that would like to be analyzed for reference accounts.

Returns:

Map containing the accountNumber-chartOfAccountsCode (key-value) foreign key pairs for all reference accounts or empty map if the BO contains no reference accounts.

listChartOfAccountsCodeNames

Set<String> listChartOfAccountsCodeNames(org.kuali.rice.kns.bo.PersistableBusinessObject bo)

Determines the list of chartOfAccountsCode fields as one of the foreign keys of the reference accounts (or other account-involved BOs) contained within the specified parent object. For example, an Account object contains reportsToAccount with reportsToChartOfAccountsCode as one of the foreign keys. Note: these do not include the following cases: - nested reference accounts - reference accounts in collections - reference accounts whose PKs are also PKs of the BO - reference accounts whose PKs don't exist in the BO as foreign keys but are referred by the maintainance page in a nested way - non-existing reference accounts whose PKs exist in the BO as foreign keys (this should never happen) - non-maintainable reference accounts

Parameters:

bo - BusinessObject (or subclass) instance that would like to be analyzed for reference accounts.

Returns:

Set containing the chartOfAccountsCode foreign key names for all reference accounts or empty set if the BO contains no reference accounts.

listAccountNumberNames

Set<String> listAccountNumberNames(org.kuali.rice.kns.bo.PersistableBusinessObject bo)

Determines the list of accountNumber fields as one of the foreign keys of the reference accounts (or other account-involved BOs) contained within the specified parent object. For example, an Account object contains reportsToAccount with reportsToAccountNumber as one of the foreign keys. Note: these do not include the following cases: - nested reference accounts - reference accounts in collections - reference accounts whose PKs are also PKs of the BO - reference accounts whose PKs don't exist in the BO as foreign keys but are referred by the maintainance page in a nested way - non-existing reference accounts whose PKs exist in the BO as foreign keys (this should never happen) - non-maintainable reference accounts

Parameters:

bo - BusinessObject (or subclass) instance that would like to be analyzed for reference accounts.

Returns:

Set containing the accountNumber foreign key names for all reference accounts or empty set if the BO contains no reference accounts.

getChartOfAccountsCodeName

String getChartOfAccountsCodeName(org.kuali.rice.kns.bo.PersistableBusinessObject bo,
                                  String accountNumberFieldName)

Gets the name of the chartOfAccountsCode field as one foreign key, paired with the specified accountNumber field as the other, of the reference account (or other account-involved BO) contained within the specified parent object. For example, an Account object contains reportsToAccount with reportsToChartOfAccountsCode and reportsToAccountNumber as the foreign key pair.

Parameters:

bo - BusinessObject (or subclass) instance that would like to be analyzed for reference accounts.

accountNumberFieldName - the name of the foreign key corresponding to the primary key accountNumber of the reference account.

Returns:

the chartOfAccountsCode field name of the reference account identified by foreign key accountNumberFieldName, or empty string if the BO contains no such reference account.

getAccountNumberName

String getAccountNumberName(org.kuali.rice.kns.bo.PersistableBusinessObject bo,
                            String chartOfAccountsCodeFieldName)

Gets the name of the accountNumber field as one foreign key, paired with the specified chartOfAccountsCode field as the other, of the reference account (or other account-involved BO) contained within the specified parent object. For example, an Account object contains reportsToAccount with reportsToAccountNumber and reportsToChartOfAccountsCode as the foreign key pair.

Parameters:

bo - BusinessObject (or subclass) instance that would like to be analyzed for reference accounts.

chartOfAccountsCodeFieldName - the name of the foreign key corresponding to the primary key chartOfAccountsCode of the reference account.

Returns:

the accountNumber field name of the reference account identified by foreign key chartOfAccountsCode, or empty string if the BO contains no such reference account.