org.kuali.ole.coa.service.impl

Class OrganizationServiceImpl

java.lang.Object

org.kuali.ole.coa.service.impl.OrganizationServiceImpl

All Implemented Interfaces:

OrganizationService

public class OrganizationServiceImpl
extends Object
implements OrganizationService

This class is the service implementation for the Org structure. This is the default implementation, that is delivered with Kuali.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.kuali.rice.krad.service.BusinessObjectService	boService
protected ChartService	chartService
protected org.kuali.rice.coreservice.framework.parameter.ParameterService	parameterService
protected Map<ChartOrgHolderImpl,ChartOrgHolderImpl>	parentOrgCache

Constructor Summary

Constructors

Constructor and Description
OrganizationServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
void	flushParentOrgCache() Flushes an internal cache used to resolve parent organizations.
List<Account>	getActiveAccountsByOrg(String chartOfAccountsCode, String organizationCode) Retrieves a List of Accounts that are active, and are tied to this Org.
List<Organization>	getActiveChildOrgs(String chartOfAccountsCode, String organizationCode) Retrieves a List of Orgs that are active, and that ReportTo this Org If there are no Orgs that meet this criteria, an empty list will be returned.
List<Organization>	getActiveFinancialOrgs() Returns a list of active financial processing organizations.
List<Organization>	getActiveOrgsByType(String organizationTypeCode) Returns a list of active organizations with the given organization type code.
Organization	getByPrimaryId(String chartOfAccountsCode, String organizationCode) This method retrieves an organization instance by its composite primary keys (parameters passed in).
Organization	getByPrimaryIdWithCaching(String chartOfAccountsCode, String organizationCode) Implements the getByPrimaryId method defined by OrganizationService.
String[]	getRootOrganizationCode() TODO: refactor me to a ChartOrgHolder
protected boolean	isParentOrganization_Internal(ChartOrgHolderImpl currOrg, ChartOrgHolderImpl desiredParentOrg, List<ChartOrgHolderImpl> traversedOrgs) This helper method handles the case where there might be cycles in the data.
boolean	isParentOrganization(String childChartOfAccountsCode, String childOrganizationCode, String parentChartOfAccountsCode, String parentOrganizationCode) This method traverses the hierarchy to see if the organization represented by the potentialChildChartCode and potentialChildOrganizationCode reports to the organization represented by the potentialParentChartCode and potentialParentOrganizationCode
protected void	loadParentOrgCache()
void	setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService boService)
void	setChartService(ChartService chartService)
void	setParameterService(org.kuali.rice.coreservice.framework.parameter.ParameterService parameterService)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

parameterService

protected org.kuali.rice.coreservice.framework.parameter.ParameterService parameterService

chartService

protected ChartService chartService

boService

protected org.kuali.rice.krad.service.BusinessObjectService boService

parentOrgCache

protected Map<ChartOrgHolderImpl,ChartOrgHolderImpl> parentOrgCache

Constructor Detail

OrganizationServiceImpl

public OrganizationServiceImpl()

Method Detail

getByPrimaryId

public Organization getByPrimaryId(String chartOfAccountsCode,
                          String organizationCode)

Description copied from interface: OrganizationService

This method retrieves an organization instance by its composite primary keys (parameters passed in).

Specified by:

getByPrimaryId in interface OrganizationService

Returns:

An Org instance.

See Also:

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

getByPrimaryIdWithCaching

@Cacheable(value="OLE/Organization",
           key="#p0+\'-\'+#p1")
public Organization getByPrimaryIdWithCaching(String chartOfAccountsCode,
                                               String organizationCode)

Implements the getByPrimaryId method defined by OrganizationService. Method is used by KualiOrgReviewAttribute to enable caching of orgs for routing.

Specified by:

getByPrimaryIdWithCaching in interface OrganizationService

See Also:

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

getActiveAccountsByOrg

public List<Account> getActiveAccountsByOrg(String chartOfAccountsCode,
                                   String organizationCode)

Description copied from interface: OrganizationService

Retrieves a List of Accounts that are active, and are tied to this Org. If there are no Accounts that meet this criteria, an empty list will be returned.

Specified by:

getActiveAccountsByOrg in interface OrganizationService

Parameters:

chartOfAccountsCode - - chartCode for the Org you want Accounts for

organizationCode - - orgCode for the Org you want Accounts for

Returns:

A List of Accounts that are active, and tied to this Org

See Also:

OrganizationService.getActiveAccountsByOrg(java.lang.String, java.lang.String)

getActiveChildOrgs

public List<Organization> getActiveChildOrgs(String chartOfAccountsCode,
                                    String organizationCode)

Description copied from interface: OrganizationService

Retrieves a List of Orgs that are active, and that ReportTo this Org If there are no Orgs that meet this criteria, an empty list will be returned.

Specified by:

getActiveChildOrgs in interface OrganizationService

Parameters:

chartOfAccountsCode - - chartCode for the Org you want Child Orgs for

organizationCode - - orgCode for the Org you want Child Orgs for

Returns:

A List of Orgs that are active, and report to this Org

See Also:

OrganizationService.getActiveChildOrgs(java.lang.String, java.lang.String)

loadParentOrgCache

protected void loadParentOrgCache()

flushParentOrgCache

public void flushParentOrgCache()

Description copied from interface: OrganizationService

Flushes an internal cache used to resolve parent organizations. Called from the KualiOrgMaintainable when an org is saved via the document.

Specified by:

flushParentOrgCache in interface OrganizationService

isParentOrganization

public boolean isParentOrganization(String childChartOfAccountsCode,
                           String childOrganizationCode,
                           String parentChartOfAccountsCode,
                           String parentOrganizationCode)

Description copied from interface: OrganizationService

This method traverses the hierarchy to see if the organization represented by the potentialChildChartCode and potentialChildOrganizationCode reports to the organization represented by the potentialParentChartCode and potentialParentOrganizationCode

Specified by:

isParentOrganization in interface OrganizationService

Returns:

boolean indicating whether the organization represented by the first two parameters reports to one represented by the last two parameters

isParentOrganization_Internal

protected boolean isParentOrganization_Internal(ChartOrgHolderImpl currOrg,
                                    ChartOrgHolderImpl desiredParentOrg,
                                    List<ChartOrgHolderImpl> traversedOrgs)

This helper method handles the case where there might be cycles in the data.

getActiveOrgsByType

public List<Organization> getActiveOrgsByType(String organizationTypeCode)

Description copied from interface: OrganizationService

Returns a list of active organizations with the given organization type code.

Specified by:

getActiveOrgsByType in interface OrganizationService

Returns:

See Also:

OrganizationService.getActiveOrgsByType(java.lang.String)

getActiveFinancialOrgs

public List<Organization> getActiveFinancialOrgs()

Description copied from interface: OrganizationService

Returns a list of active financial processing organizations.

Specified by:

getActiveFinancialOrgs in interface OrganizationService

Returns:

A List of Orgs that are active and financial processing.

See Also:

OrganizationService.getActiveFinancialOrgs()

getRootOrganizationCode

public String[] getRootOrganizationCode()

TODO: refactor me to a ChartOrgHolder

Specified by:

getRootOrganizationCode in interface OrganizationService

See Also:

OrganizationService.getRootOrganizationCode()

setParameterService

public void setParameterService(org.kuali.rice.coreservice.framework.parameter.ParameterService parameterService)

setBusinessObjectService

public void setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService boService)

setChartService

public void setChartService(ChartService chartService)