org.kuali.ole.fp.service.impl

Class FiscalYearFunctionControlServiceImpl

java.lang.Object

org.kuali.ole.fp.service.impl.FiscalYearFunctionControlServiceImpl

All Implemented Interfaces:

FiscalYearFunctionControlService

public class FiscalYearFunctionControlServiceImpl
extends Object
implements FiscalYearFunctionControlService

This is the default implementation of the FiscalyearFunctionControlService interface.

Field Summary

Fields

Modifier and Type	Field and Description
static String	FY_FUNCTION_CONTROL_BA_ALLOWED
static String	FY_FUNCTION_CONTROL_BASE_AMT_ALLOWED

Constructor Summary

Constructors

Constructor and Description
FiscalYearFunctionControlServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
List<Integer>	getActiveBudgetYear() returns a list of years for which budget construction is visible in the application
protected boolean	getActiveIndByPrimaryId(Integer postingYear, String financialSystemFunctionControlCode) Retrieves the FiscalYearFunctionControl by its composite primary key (all passed in as parameters) and returns the active indicator.
List	getBudgetAdjustmentAllowedYears() Retrieves a collection of FiscalYearFunctionControls allowed for use in a budget adjustment.
org.kuali.rice.krad.service.BusinessObjectService	getBusinessObjectService() Gets the value of the businessObjectService attribute.
protected List	getByFunctionControlCodeAndActiveInd(String financialSystemFunctionControlCode, String financialSystemFunctionActiveIndicator) Retrieves list of FiscalYearFunctionControls by its function control code.
boolean	isApplicationUpdateFromHumanResourcesAllowed(Integer universityFiscalYear) checks the fiscal year against the control table to see if a user can force a refresh of human resources data for selected organizations in the budget construction security tree from the application
boolean	isBaseAmountChangeAllowed(Integer postingYear) This method retrieves the value of the active indicator for a FiscalYearFunctionControl instance for the given posting year.
boolean	isBatchUpdateFromHumanResourcesAllowed(Integer universityFiscalYear) checks the fiscal year against the control table to see if the batch process will do a global update (ALL changes found) of the human-resource derived data in budget construction
boolean	isBatchUpdateFromPayrollAllowed(Integer universityFiscalYear) checks the fiscal year against the control table to see if the batch process will update base salaries in the budget using the CalculatedSalaryFoundation data derived from payroll
boolean	isBudgetConstructionActive(Integer universityFiscalYear) checks the fiscal year against the control table to see if users can view budget construction data in the application
boolean	isBudgetGeneralLedgerUpdateAllowed(Integer universityFiscalYear) checks the fiscal year against the control table to see if the general ledger in budget construction should reflect current base budget amounts in the accounting general ledger for the fiscal year
boolean	isBudgetUpdateAllowed(Integer universityFiscalYear) checks the fiscal year against the control table to see if users can make edits to budget construction for the given year (some users may still be frozen out because of the security mechanism)
void	setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService) Sets the businessObjectService attribute.

Methods inherited from class java.lang.Object

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

Field Detail

FY_FUNCTION_CONTROL_BA_ALLOWED

public static String FY_FUNCTION_CONTROL_BA_ALLOWED

FY_FUNCTION_CONTROL_BASE_AMT_ALLOWED

public static String FY_FUNCTION_CONTROL_BASE_AMT_ALLOWED

Constructor Detail

FiscalYearFunctionControlServiceImpl

public FiscalYearFunctionControlServiceImpl()

Method Detail

getActiveIndByPrimaryId

protected boolean getActiveIndByPrimaryId(Integer postingYear,
                              String financialSystemFunctionControlCode)

Retrieves the FiscalYearFunctionControl by its composite primary key (all passed in as parameters) and returns the active indicator.

Parameters:

postingYear - The posting year associated with the fiscal year function control being retrieved.

financialSystemFunctionControlCode - The function control code associated with the fiscal year function control being retrieved.

Returns:

Returns the value of the active indicator; returns null if PK is not found

getByFunctionControlCodeAndActiveInd

protected List getByFunctionControlCodeAndActiveInd(String financialSystemFunctionControlCode,
                                        String financialSystemFunctionActiveIndicator)

Retrieves list of FiscalYearFunctionControls by its function control code.

Parameters:

financialSystemFunctionControlCode - The function control code to search by.

financialSystemFunctionActiveIndicator - An active indicator used as a search parameter.

Returns:

The list of FiscalYearFunctionControls matching the search criteria provided.

getBudgetAdjustmentAllowedYears

public List getBudgetAdjustmentAllowedYears()

Retrieves a collection of FiscalYearFunctionControls allowed for use in a budget adjustment.

Specified by:

getBudgetAdjustmentAllowedYears in interface FiscalYearFunctionControlService

Returns:

A collection of FiscalYearFunctionControls representing the years allowed in a budget adjustment.

See Also:

FiscalYearFunctionControlService#getBudgetAdjustmentAllowedYears(String)

isBaseAmountChangeAllowed

public boolean isBaseAmountChangeAllowed(Integer postingYear)

This method retrieves the value of the active indicator for a FiscalYearFunctionControl instance for the given posting year.

Specified by:

isBaseAmountChangeAllowed in interface FiscalYearFunctionControlService

Parameters:

postingYear - The posting year used as a search parameter.

Returns:

True if the active indicator for the retrieved FiscalYearFunctionControl value retrieved is true, false otherwise.

See Also:

FiscalYearFunctionControlService#isBaseAmountChangeAllowed(Integer, String)

getActiveBudgetYear

public List<Integer> getActiveBudgetYear()

Description copied from interface: FiscalYearFunctionControlService

returns a list of years for which budget construction is visible in the application

Specified by:

getActiveBudgetYear in interface FiscalYearFunctionControlService

Returns:

list of type integer

See Also:

FiscalYearFunctionControlService.getActiveBudgetYear()

isApplicationUpdateFromHumanResourcesAllowed

public boolean isApplicationUpdateFromHumanResourcesAllowed(Integer universityFiscalYear)

Description copied from interface: FiscalYearFunctionControlService

checks the fiscal year against the control table to see if a user can force a refresh of human resources data for selected organizations in the budget construction security tree from the application

Specified by:

isApplicationUpdateFromHumanResourcesAllowed in interface FiscalYearFunctionControlService

Returns:

true if selected human resources updates are allowed.

See Also:

FiscalYearFunctionControlService.isApplicationUpdateFromHumanResourcesAllowed(java.lang.Integer)

isBatchUpdateFromHumanResourcesAllowed

public boolean isBatchUpdateFromHumanResourcesAllowed(Integer universityFiscalYear)

Description copied from interface: FiscalYearFunctionControlService

checks the fiscal year against the control table to see if the batch process will do a global update (ALL changes found) of the human-resource derived data in budget construction

Specified by:

isBatchUpdateFromHumanResourcesAllowed in interface FiscalYearFunctionControlService

Returns:

true if the batch processes will feed human resource data changes into budget construction

See Also:

FiscalYearFunctionControlService.isBatchUpdateFromHumanResourcesAllowed(java.lang.Integer)

isBatchUpdateFromPayrollAllowed

public boolean isBatchUpdateFromPayrollAllowed(Integer universityFiscalYear)

Description copied from interface: FiscalYearFunctionControlService

checks the fiscal year against the control table to see if the batch process will update base salaries in the budget using the CalculatedSalaryFoundation data derived from payroll

Specified by:

isBatchUpdateFromPayrollAllowed in interface FiscalYearFunctionControlService

Returns:

true if base salaries will be changed

See Also:

FiscalYearFunctionControlService.isBatchUpdateFromPayrollAllowed(java.lang.Integer)

isBudgetConstructionActive

public boolean isBudgetConstructionActive(Integer universityFiscalYear)

Description copied from interface: FiscalYearFunctionControlService

checks the fiscal year against the control table to see if users can view budget construction data in the application

Specified by:

isBudgetConstructionActive in interface FiscalYearFunctionControlService

Returns:

true if the budget construction data is viewable in general (in other words, security may still freeze some viewers out even though everyone is not excluded)

isBudgetGeneralLedgerUpdateAllowed

public boolean isBudgetGeneralLedgerUpdateAllowed(Integer universityFiscalYear)

Description copied from interface: FiscalYearFunctionControlService

checks the fiscal year against the control table to see if the general ledger in budget construction should reflect current base budget amounts in the accounting general ledger for the fiscal year

Specified by:

isBudgetGeneralLedgerUpdateAllowed in interface FiscalYearFunctionControlService

Returns:

true if updates are allowed

See Also:

FiscalYearFunctionControlService.isBudgetGeneralLedgerUpdateAllowed(java.lang.Integer)

isBudgetUpdateAllowed

public boolean isBudgetUpdateAllowed(Integer universityFiscalYear)

Description copied from interface: FiscalYearFunctionControlService

checks the fiscal year against the control table to see if users can make edits to budget construction for the given year (some users may still be frozen out because of the security mechanism)

Specified by:

isBudgetUpdateAllowed in interface FiscalYearFunctionControlService

Returns:

true if authorized users can update budget construction using the application

getBusinessObjectService

public org.kuali.rice.krad.service.BusinessObjectService getBusinessObjectService()

Gets the value of the businessObjectService attribute.

Returns:

An instance of the businessObjectService attribute.

setBusinessObjectService

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

Sets the businessObjectService attribute.

Parameters:

businessObjectService - The businessObjectService instance to set.