org.kuali.ole.coa.service

Interface OrganizationService

All Known Implementing Classes:

OrganizationServiceImpl

public interface OrganizationService

This interface defines methods that an Org Service must provide.

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) Method is used by KualiOrgReviewAttribute to enable caching of orgs for routing.
String[]	getRootOrganizationCode() returns the chart and organization of the ACTIVE root-level organization
boolean	isParentOrganization(String potentialChildChartCode, String potentialChildOrganizationCode, String potentialParentChartCode, String potentialParentOrganizationCode) 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

Method Detail

getByPrimaryId

Organization getByPrimaryId(String chartOfAccountsCode,
                          String organizationCode)

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

Parameters:

chartOfAccountsCode -

organizationCode -

Returns:

An Org instance.

getByPrimaryIdWithCaching

Organization getByPrimaryIdWithCaching(String chartOfAccountsCode,
                                     String organizationCode)

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

See Also:

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

getActiveAccountsByOrg

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

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.

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

getActiveChildOrgs

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.

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

getActiveOrgsByType

List<Organization> getActiveOrgsByType(String organizationTypeCode)

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

Parameters:

organizationTypeCode -

Returns:

getActiveFinancialOrgs

List<Organization> getActiveFinancialOrgs()

Returns a list of active financial processing organizations.

Returns:

A List of Orgs that are active and financial processing.

getRootOrganizationCode

String[] getRootOrganizationCode()

returns the chart and organization of the ACTIVE root-level organization

isParentOrganization

boolean isParentOrganization(String potentialChildChartCode,
                           String potentialChildOrganizationCode,
                           String potentialParentChartCode,
                           String potentialParentOrganizationCode)

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

Parameters:

potentialChildChartCode -

potentialChildOrganizationCode -

potentialParentChartCode -

potentialParentOrganizationCode -

Returns:

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

flushParentOrgCache

void flushParentOrgCache()

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