org.kuali.kfs.module.bc.document.web.struts
Class SalarySettingBaseAction

java.lang.Object
  org.apache.struts.action.Action
      org.apache.struts.actions.DispatchAction
          org.kuali.rice.kns.web.struts.action.KualiAction
              org.kuali.kfs.module.bc.document.web.struts.BudgetExpansionAction
                  org.kuali.kfs.module.bc.document.web.struts.SalarySettingBaseAction

Direct Known Subclasses:

DetailSalarySettingAction, QuickSalarySettingAction

public abstract class SalarySettingBaseAction
extends BudgetExpansionAction

the base action class for salary setting, which provides the implementations of common actions of the salary setting screens

Field Summary

Fields inherited from class org.kuali.rice.kns.web.struts.action.KualiAction

FORM_ACTION, FORWARD_NEXT, FORWARD_TEXT_AREA_UPDATE, METHOD_TO_CALL, POST_TEXT_AREA_TO_PARENT, TEXT_AREA_FIELD_ANCHOR, TEXT_AREA_FIELD_LABEL, TEXT_AREA_FIELD_NAME, TEXT_AREA_MAX_LENGTH, TEXT_AREA_READ_ONLY

Fields inherited from class org.apache.struts.actions.DispatchAction

clazz, log, messages, methods, types

Fields inherited from class org.apache.struts.action.Action

defaultLocale, servlet

Constructor Summary

SalarySettingBaseAction()

Method Summary

protected void	adjustSalary(PendingBudgetConstructionAppointmentFunding appointmentFunding) adjust the requested salary amount of the given appointment funding line
org.apache.struts.action.ActionForward	adjustSalarySettingLinePercent(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) adjust the salary amount of the specified funding line
org.apache.struts.action.ActionForward	adjustSalarySettingLinePercent(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, PendingBudgetConstructionAppointmentFunding appointmentFunding, BudgetConstructionDocument document, String errorKeyPrefix) adjust the requested salary amount of the given appointment funding line by pecent or given amount
org.apache.struts.action.ActionForward	close(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Handling for screen close.
org.apache.struts.action.ActionForward	deleteSalarySettingLine(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) mark the selected salary setting line as deleted
org.apache.struts.action.ActionForward	execute(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected String	getErrorKeyPrefixOfAppointmentFundingLine(List<PendingBudgetConstructionAppointmentFunding> appointmentFundings, PendingBudgetConstructionAppointmentFunding appointmentFunding) build the error key prefix based on the given information
protected abstract String	getFundingAwareObjectName() get the name of object that holds a set of appointment funding lines
protected PendingBudgetConstructionAppointmentFunding	getSelectedFundingLine(javax.servlet.http.HttpServletRequest request, SalarySettingBaseForm salarySettingForm) get the selected appointment funding line
protected void	initAuthorization(SalarySettingBaseForm salarySettingForm)
protected boolean	invokeRules(org.kuali.rice.kns.rule.event.KualiDocumentEvent event) execute the rules associated with the given event
abstract org.apache.struts.action.ActionForward	loadExpansionScreen(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) loads the data for the expansion screen based on the passed in url parameters
org.apache.struts.action.ActionForward	normalizePayRateAndAmount(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) normalize the hourly pay rate and annual pay amount
protected void	populateAuthorizationFields(SalarySettingBaseForm salarySettingForm)
org.apache.struts.action.ActionForward	purgeSalarySettingLine(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) mark the selected salary setting line as purged
org.apache.struts.action.ActionForward	restorePurgedSalarySettingLine(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) restore the selected salary setting line if it is marked as purged
protected org.apache.struts.action.ActionForward	returnAfterClose(SalarySettingBaseForm salarySettingForm, org.apache.struts.action.ActionMapping mapping, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) return after salary setting is closed
org.apache.struts.action.ActionForward	revertSalarySettingLine(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) revert the selected salary setting line that just has been marked as deleted
org.apache.struts.action.ActionForward	save(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) save the information in the current form into underlying data store
org.apache.struts.action.ActionForward	undeleteSalarySettingLine(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) unmark the selected salary setting line that has been marked as deleted
org.apache.struts.action.ActionForward	vacateSalarySettingLine(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) vacate the specified appointment funding line

Methods inherited from class org.kuali.kfs.module.bc.document.web.struts.BudgetExpansionAction

addCallBackMessagesAsObjectInSession, cleanupAnySessionForm, moveCallBackMessagesInPlace, refresh, removeCallBackMessagesObjectFromSession, returnToCaller

Methods inherited from class org.kuali.rice.kns.web.struts.action.KualiAction

addMethodToCallToUncheckedList, checkAuthorization, defaultDispatch, dispatchMethod, doProcessingAfterPost, findMethodToCall, getApplicationBaseUrl, getBasePath, getBusinessObjectAuthorizationService, getEncryptionService, getHeaderTabDispatch, getHeaderTabNavigateTo, getImageContext, getKualiModuleService, getLineToDelete, getReturnLocation, getRoleQualification, getSelectedLine, getTabToToggle, headerTab, hideAllTabs, performInquiry, performLookup, performQuestionWithInput, performQuestionWithInputAgainBecauseOfErrors, performQuestionWithoutInput, performWorkgroupLookup, postTextAreaToParent, retrieveLookupParameterValue, showAllTabs, toggleTab, updateTextArea, validateLookupInquiryFullParameter

Methods inherited from class org.apache.struts.actions.DispatchAction

cancelled, getMethod, getMethodName, getParameter, unspecified

Methods inherited from class org.apache.struts.action.Action

addErrors, addMessages, execute, generateToken, getDataSource, getDataSource, getErrors, getLocale, getMessages, getResources, getResources, getServlet, isCancelled, isTokenValid, isTokenValid, resetToken, saveErrors, saveErrors, saveErrors, saveMessages, saveMessages, saveToken, setLocale, setServlet

Methods inherited from class java.lang.Object

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

Constructor Detail

SalarySettingBaseAction

public SalarySettingBaseAction()

Method Detail

loadExpansionScreen

public abstract org.apache.struts.action.ActionForward loadExpansionScreen(org.apache.struts.action.ActionMapping mapping,
                                                                           org.apache.struts.action.ActionForm form,
                                                                           javax.servlet.http.HttpServletRequest request,
                                                                           javax.servlet.http.HttpServletResponse response)
                                                                    throws Exception

loads the data for the expansion screen based on the passed in url parameters

Throws:

Exception

execute

public org.apache.struts.action.ActionForward execute(org.apache.struts.action.ActionMapping mapping,
                                                      org.apache.struts.action.ActionForm form,
                                                      javax.servlet.http.HttpServletRequest request,
                                                      javax.servlet.http.HttpServletResponse response)
                                               throws Exception

Overrides:

execute in class BudgetExpansionAction

Throws:

Exception

See Also:

KualiAction.execute(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

populateAuthorizationFields

protected void populateAuthorizationFields(SalarySettingBaseForm salarySettingForm)

initAuthorization

protected void initAuthorization(SalarySettingBaseForm salarySettingForm)

save

public org.apache.struts.action.ActionForward save(org.apache.struts.action.ActionMapping mapping,
                                                   org.apache.struts.action.ActionForm form,
                                                   javax.servlet.http.HttpServletRequest request,
                                                   javax.servlet.http.HttpServletResponse response)
                                            throws Exception

save the information in the current form into underlying data store

Throws:

Exception

close

public org.apache.struts.action.ActionForward close(org.apache.struts.action.ActionMapping mapping,
                                                    org.apache.struts.action.ActionForm form,
                                                    javax.servlet.http.HttpServletRequest request,
                                                    javax.servlet.http.HttpServletResponse response)
                                             throws Exception

Description copied from class: BudgetExpansionAction

Handling for screen close. Default action is return to caller.

Overrides:

close in class BudgetExpansionAction

Throws:

Exception

See Also:

BudgetExpansionAction.close(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

vacateSalarySettingLine

public org.apache.struts.action.ActionForward vacateSalarySettingLine(org.apache.struts.action.ActionMapping mapping,
                                                                      org.apache.struts.action.ActionForm form,
                                                                      javax.servlet.http.HttpServletRequest request,
                                                                      javax.servlet.http.HttpServletResponse response)
                                                               throws Exception

vacate the specified appointment funding line

Throws:

Exception

purgeSalarySettingLine

public org.apache.struts.action.ActionForward purgeSalarySettingLine(org.apache.struts.action.ActionMapping mapping,
                                                                     org.apache.struts.action.ActionForm form,
                                                                     javax.servlet.http.HttpServletRequest request,
                                                                     javax.servlet.http.HttpServletResponse response)
                                                              throws Exception

mark the selected salary setting line as purged

Throws:

Exception

restorePurgedSalarySettingLine

public org.apache.struts.action.ActionForward restorePurgedSalarySettingLine(org.apache.struts.action.ActionMapping mapping,
                                                                             org.apache.struts.action.ActionForm form,
                                                                             javax.servlet.http.HttpServletRequest request,
                                                                             javax.servlet.http.HttpServletResponse response)
                                                                      throws Exception

restore the selected salary setting line if it is marked as purged

Throws:

Exception

deleteSalarySettingLine

public org.apache.struts.action.ActionForward deleteSalarySettingLine(org.apache.struts.action.ActionMapping mapping,
                                                                      org.apache.struts.action.ActionForm form,
                                                                      javax.servlet.http.HttpServletRequest request,
                                                                      javax.servlet.http.HttpServletResponse response)
                                                               throws Exception

mark the selected salary setting line as deleted

Throws:

Exception

undeleteSalarySettingLine

public org.apache.struts.action.ActionForward undeleteSalarySettingLine(org.apache.struts.action.ActionMapping mapping,
                                                                        org.apache.struts.action.ActionForm form,
                                                                        javax.servlet.http.HttpServletRequest request,
                                                                        javax.servlet.http.HttpServletResponse response)
                                                                 throws Exception

unmark the selected salary setting line that has been marked as deleted

Throws:

Exception

revertSalarySettingLine

public org.apache.struts.action.ActionForward revertSalarySettingLine(org.apache.struts.action.ActionMapping mapping,
                                                                      org.apache.struts.action.ActionForm form,
                                                                      javax.servlet.http.HttpServletRequest request,
                                                                      javax.servlet.http.HttpServletResponse response)
                                                               throws Exception

revert the selected salary setting line that just has been marked as deleted

Throws:

Exception

adjustSalarySettingLinePercent

public org.apache.struts.action.ActionForward adjustSalarySettingLinePercent(org.apache.struts.action.ActionMapping mapping,
                                                                             org.apache.struts.action.ActionForm form,
                                                                             javax.servlet.http.HttpServletRequest request,
                                                                             javax.servlet.http.HttpServletResponse response)
                                                                      throws Exception

adjust the salary amount of the specified funding line

Throws:

Exception

adjustSalarySettingLinePercent

public org.apache.struts.action.ActionForward adjustSalarySettingLinePercent(org.apache.struts.action.ActionMapping mapping,
                                                                             org.apache.struts.action.ActionForm form,
                                                                             PendingBudgetConstructionAppointmentFunding appointmentFunding,
                                                                             BudgetConstructionDocument document,
                                                                             String errorKeyPrefix)

adjust the requested salary amount of the given appointment funding line by pecent or given amount

adjustSalary

protected void adjustSalary(PendingBudgetConstructionAppointmentFunding appointmentFunding)

adjust the requested salary amount of the given appointment funding line

normalizePayRateAndAmount

public org.apache.struts.action.ActionForward normalizePayRateAndAmount(org.apache.struts.action.ActionMapping mapping,
                                                                        org.apache.struts.action.ActionForm form,
                                                                        javax.servlet.http.HttpServletRequest request,
                                                                        javax.servlet.http.HttpServletResponse response)
                                                                 throws Exception

normalize the hourly pay rate and annual pay amount

Throws:

Exception

getSelectedFundingLine

protected PendingBudgetConstructionAppointmentFunding getSelectedFundingLine(javax.servlet.http.HttpServletRequest request,
                                                                             SalarySettingBaseForm salarySettingForm)

get the selected appointment funding line

invokeRules

protected boolean invokeRules(org.kuali.rice.kns.rule.event.KualiDocumentEvent event)

execute the rules associated with the given event

Parameters:

event - the event that just occured

Returns:

true if the rules associated with the given event pass; otherwise, false

getErrorKeyPrefixOfAppointmentFundingLine

protected String getErrorKeyPrefixOfAppointmentFundingLine(List<PendingBudgetConstructionAppointmentFunding> appointmentFundings,
                                                           PendingBudgetConstructionAppointmentFunding appointmentFunding)

build the error key prefix based on the given information

Parameters:

fundingAwareObjectName - the name of object that holds the given set of appointment funding lines

appointmentFundings - the given set of appointment funding lines

appointmentFunding - the given appointment funding line

Returns:

the error key prefix built from the given information

returnAfterClose

protected org.apache.struts.action.ActionForward returnAfterClose(SalarySettingBaseForm salarySettingForm,
                                                                  org.apache.struts.action.ActionMapping mapping,
                                                                  javax.servlet.http.HttpServletRequest request,
                                                                  javax.servlet.http.HttpServletResponse response)
                                                           throws Exception

return after salary setting is closed

Throws:

Exception

getFundingAwareObjectName

protected abstract String getFundingAwareObjectName()

get the name of object that holds a set of appointment funding lines