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

java.lang.Object
  extended by org.apache.struts.action.Action
      extended by org.apache.struts.actions.DispatchAction
          extended by org.kuali.rice.kns.web.struts.action.KualiAction
              extended by org.kuali.rice.kns.web.struts.action.KualiLookupAction
                  extended by org.kuali.kfs.module.bc.document.web.struts.TempListLookupAction

public class TempListLookupAction
extends org.kuali.rice.kns.web.struts.action.KualiLookupAction

Action class to display special budget lookup 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
TempListLookupAction()
           
 
Method Summary
protected  String buildLockKeyMessage(String lockType, String lockUserId, String chartOfAccountsCode, String accountNumber, String subAccountNumber, Integer fiscalYear, String positionNumber)
          Retrieves the message text for the lock key and fills in message parameters based on the lock type.
 org.apache.struts.action.ActionForward cancel(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 org.apache.struts.action.ActionForward clearValues(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          This differs from KualiLookupAction.clearValues in that any atributes marked hidden will not be cleared.
 org.apache.struts.action.ActionForward doUnlockConfirmation(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String lockType, String lockKeyMessage)
          Gives a confirmation first time called.
 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)
           
 org.apache.struts.action.ActionForward getNewIncumbent(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Validates the get new action for incumbent then calls BudgetPositionService to pull the new incumbent record.
 org.apache.struts.action.ActionForward getNewPosition(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Validates the get new action for position then calls BudgetPositionService to pull the new position record.
 org.apache.struts.action.ActionForward performExtendedIncumbentSearch(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Forwards to intended incumbent lookup.
 org.apache.struts.action.ActionForward performExtendedPositionSearch(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Forwards to budget position lookup.
protected  BudgetConstructionLockSummary populateLockSummary(String methodToCallString)
          Parses the methodToCall parameter which contains the lock information in a known format.
 org.apache.struts.action.ActionForward start(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          TempListLookupAction can be called to build and display different lists.
 org.apache.struts.action.ActionForward submitReport(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Continues the organization report action after viewing the account list.
protected  void supressActionsIfNeeded(org.apache.struts.action.ActionForm form)
          Does not supress actions if in position or incumbent lookup mode in the BC application, otherwise calls on KualiLookupAction.supressActions
 org.apache.struts.action.ActionForward unlock(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Unlocks a current budget lock and returns back to lock monitor with refreshed locks.
 
Methods inherited from class org.kuali.rice.kns.web.struts.action.KualiLookupAction
checkAuthorization, customLookupableMethodCall, refresh, search, viewResults
 
Methods inherited from class org.kuali.rice.kns.web.struts.action.KualiAction
addMethodToCallToUncheckedList, 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

TempListLookupAction

public TempListLookupAction()
Method Detail

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 org.kuali.rice.kns.web.struts.action.KualiLookupAction
Throws:
Exception
See Also:
KualiLookupAction.execute(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

supressActionsIfNeeded

protected void supressActionsIfNeeded(org.apache.struts.action.ActionForm form)
                               throws ClassNotFoundException
Does not supress actions if in position or incumbent lookup mode in the BC application, otherwise calls on KualiLookupAction.supressActions

Overrides:
supressActionsIfNeeded in class org.kuali.rice.kns.web.struts.action.KualiLookupAction
Throws:
ClassNotFoundException
See Also:
KualiLookupAction.supressActionsIfNeeded(org.apache.struts.action.ActionForm)

start

public org.apache.struts.action.ActionForward start(org.apache.struts.action.ActionMapping mapping,
                                                    org.apache.struts.action.ActionForm form,
                                                    javax.servlet.http.HttpServletRequest request,
                                                    javax.servlet.http.HttpServletResponse response)
                                             throws Exception
TempListLookupAction can be called to build and display different lists. This method determines what the requested behavior is and either makes a build call for that list or sets up a message (if the list has already been built). If the request parameter showInitialResults is true, an initial search will be performed before display of the screen.

Overrides:
start in class org.kuali.rice.kns.web.struts.action.KualiLookupAction
Throws:
Exception
See Also:
KualiLookupAction.start(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

clearValues

public org.apache.struts.action.ActionForward clearValues(org.apache.struts.action.ActionMapping mapping,
                                                          org.apache.struts.action.ActionForm form,
                                                          javax.servlet.http.HttpServletRequest request,
                                                          javax.servlet.http.HttpServletResponse response)
                                                   throws IOException,
                                                          javax.servlet.ServletException
This differs from KualiLookupAction.clearValues in that any atributes marked hidden will not be cleared. This is to support BC temp tables that use principalId to operate on the set of rows associated with the current user.

Overrides:
clearValues in class org.kuali.rice.kns.web.struts.action.KualiLookupAction
Throws:
IOException
javax.servlet.ServletException
See Also:
KualiLookupAction.clearValues(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

cancel

public org.apache.struts.action.ActionForward cancel(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:
cancel in class org.kuali.rice.kns.web.struts.action.KualiLookupAction
Throws:
Exception
See Also:
KualiLookupAction.cancel(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

performExtendedPositionSearch

public org.apache.struts.action.ActionForward performExtendedPositionSearch(org.apache.struts.action.ActionMapping mapping,
                                                                            org.apache.struts.action.ActionForm form,
                                                                            javax.servlet.http.HttpServletRequest request,
                                                                            javax.servlet.http.HttpServletResponse response)
                                                                     throws Exception
Forwards to budget position lookup.

Throws:
Exception
See Also:
KualiLookupAction.start(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

getNewPosition

public org.apache.struts.action.ActionForward getNewPosition(org.apache.struts.action.ActionMapping mapping,
                                                             org.apache.struts.action.ActionForm form,
                                                             javax.servlet.http.HttpServletRequest request,
                                                             javax.servlet.http.HttpServletResponse response)
                                                      throws Exception
Validates the get new action for position then calls BudgetPositionService to pull the new position record.

Throws:
Exception
See Also:
KualiLookupAction.start(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

performExtendedIncumbentSearch

public org.apache.struts.action.ActionForward performExtendedIncumbentSearch(org.apache.struts.action.ActionMapping mapping,
                                                                             org.apache.struts.action.ActionForm form,
                                                                             javax.servlet.http.HttpServletRequest request,
                                                                             javax.servlet.http.HttpServletResponse response)
                                                                      throws Exception
Forwards to intended incumbent lookup.

Throws:
Exception
See Also:
KualiLookupAction.start(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

getNewIncumbent

public org.apache.struts.action.ActionForward getNewIncumbent(org.apache.struts.action.ActionMapping mapping,
                                                              org.apache.struts.action.ActionForm form,
                                                              javax.servlet.http.HttpServletRequest request,
                                                              javax.servlet.http.HttpServletResponse response)
                                                       throws Exception
Validates the get new action for incumbent then calls BudgetPositionService to pull the new incumbent record.

Throws:
Exception
See Also:
KualiLookupAction.start(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

submitReport

public org.apache.struts.action.ActionForward submitReport(org.apache.struts.action.ActionMapping mapping,
                                                           org.apache.struts.action.ActionForm form,
                                                           javax.servlet.http.HttpServletRequest request,
                                                           javax.servlet.http.HttpServletResponse response)
                                                    throws Exception
Continues the organization report action after viewing the account list.

Throws:
Exception
See Also:
KualiLookupAction.start(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

unlock

public org.apache.struts.action.ActionForward unlock(org.apache.struts.action.ActionMapping mapping,
                                                     org.apache.struts.action.ActionForm form,
                                                     javax.servlet.http.HttpServletRequest request,
                                                     javax.servlet.http.HttpServletResponse response)
                                              throws Exception
Unlocks a current budget lock and returns back to lock monitor with refreshed locks.

Throws:
Exception
See Also:
KualiAction.execute(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

doUnlockConfirmation

public org.apache.struts.action.ActionForward doUnlockConfirmation(org.apache.struts.action.ActionMapping mapping,
                                                                   org.apache.struts.action.ActionForm form,
                                                                   javax.servlet.http.HttpServletRequest request,
                                                                   javax.servlet.http.HttpServletResponse response,
                                                                   String lockType,
                                                                   String lockKeyMessage)
                                                            throws Exception
Gives a confirmation first time called. The next time will check the confirmation result. If the returned forward is not null, that indicates we are fowarding to the question or they selected No to the confirmation and we should return to the unlock page.

Throws:
Exception
See Also:
KualiAction.execute(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

populateLockSummary

protected BudgetConstructionLockSummary populateLockSummary(String methodToCallString)
Parses the methodToCall parameter which contains the lock information in a known format. Populates a BudgetConstructionLockSummary that represents the record to unlock.

Parameters:
methodToCallString - - request parameter containing lock information
Returns:
lockSummary populated from request parameter

buildLockKeyMessage

protected String buildLockKeyMessage(String lockType,
                                     String lockUserId,
                                     String chartOfAccountsCode,
                                     String accountNumber,
                                     String subAccountNumber,
                                     Integer fiscalYear,
                                     String positionNumber)
Retrieves the message text for the lock key and fills in message parameters based on the lock type.

Returns:
lockKey built from given parameters


Copyright © 2005-2012 The Kuali Foundation. All Rights Reserved.