org.kuali.kra.coi.personfinancialentity

Class FinancialEntityAction

java.lang.Object

org.apache.struts.action.Action

org.apache.struts.actions.BaseAction

org.apache.struts.actions.DispatchAction

org.kuali.rice.kns.web.struts.action.KualiAction

org.kuali.kra.coi.personfinancialentity.FinancialEntityAction

Direct Known Subclasses:

FinancialEntityEditListAction, FinancialEntityEditNewAction, FinancialEntityManagementAction

public class FinancialEntityAction
extends org.kuali.rice.kns.web.struts.action.KualiAction

This class is the struts action for financial entity maintenance

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ACTIVATE_ENTITY
protected static String	CONFIRM_NO_CANCEL_FE
protected static String	CONFIRM_NO_DELETE
protected static String	CONFIRM_YES_CANCEL_FE
protected static String	INACTIVATE_ENTITY

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, methods, types

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

messages

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

servlet

Constructor Summary

Constructors

Constructor and Description
FinancialEntityAction()

Method Summary

Methods

Modifier and Type	Method and Description
protected String	buildForwardUrl(String routeHeaderId)
protected StrutsConfirmation	buildParameterizedConfirmationQuestion(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String questionId, String configurationId, String... params) "borrowed" from KraTransactionalDocumentActionBase class
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) This method for 'close' button action.
protected boolean	checkRule(KraDocumentEventBaseExtension event) This method is to process rule check.
org.apache.struts.action.ActionForward	confirm(StrutsConfirmation question, String yesMethodName, String noMethodName) "borrowed" from KraTransactionalDocumentActionBase class
org.apache.struts.action.ActionForward	confirmCancelFinancialEntity(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	declineCancelFinancialEntity(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	editList(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method is to forward to 'My Financial Entities' page.
org.apache.struts.action.ActionForward	editNew(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method is to forward to 'New Financial Entity' page
protected org.kuali.rice.krad.service.BusinessObjectService	getBusinessObjectService()
protected CoiDisclosureService	getCoiDisclosureService()
protected CoiPrintingService	getCoiPrintingService()
protected List<PersonFinIntDisclosure>	getFinancialEntities(boolean active)
protected List<PersonFinIntDisclosure>	getFinancialEntities(String personId, boolean active)
protected FinancialEntityService	getFinancialEntityService()
protected org.kuali.rice.krad.service.SequenceAccessorService	getSequenceAccessorService()
protected static String	getValidHeaderString(String s)
protected WatermarkService	getWatermarkService()
protected boolean	isValidToSave(PersonFinIntDisclosure personFinIntDisclosure, String errorPath)
org.apache.struts.action.ActionForward	management(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method is called when user open the financial entity maintenance page
protected org.apache.struts.action.ActionForward	performQuestionWithoutInput(StrutsConfirmation question, String context) "borrowed" from KraTransactionalDocumentActionBase class
protected void	recordSubmitActionSuccess(String submitAction) This method is for header message displaying
org.apache.struts.action.ActionForward	refresh(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This is specifically for 'sponsor' lookup' when return a value, the addresses fields will be overriden.
protected void	saveFinancialEntity(org.apache.struts.action.ActionForm form, PersonFinIntDisclosure personFinIntDisclosure)
org.apache.struts.action.ActionForward	viewFinancialEntityAttachment(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	viewFinancialEntityAttachmentFromSummary(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	whereToGoAfterCancel(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)

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

addMethodToCallToUncheckedList, checkAuthorization, defaultDispatch, dispatchMethod, doProcessingAfterPost, execute, findMethodToCall, getApplicationBaseUrl, getBusinessObjectAuthorizationService, getEncryptionService, getHeaderTabDispatch, getHeaderTabNavigateTo, getImageContext, getKualiModuleService, getLineToDelete, getLineToEdit, getReturnLocation, getRoleQualification, getSelectedLine, getTabToToggle, headerTab, hideAllTabs, isModuleLocked, 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, getErrors, getLocale, getMessages, getResources, getResources, getServlet, isCancelled, isTokenValid, isTokenValid, resetToken, 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

Field Detail

INACTIVATE_ENTITY

protected static final String INACTIVATE_ENTITY

See Also:

Constant Field Values

ACTIVATE_ENTITY

protected static final String ACTIVATE_ENTITY

See Also:

Constant Field Values

CONFIRM_YES_CANCEL_FE

protected static final String CONFIRM_YES_CANCEL_FE

See Also:

Constant Field Values

CONFIRM_NO_CANCEL_FE

protected static final String CONFIRM_NO_CANCEL_FE

See Also:

Constant Field Values

CONFIRM_NO_DELETE

protected static final String CONFIRM_NO_DELETE

See Also:

Constant Field Values

Constructor Detail

FinancialEntityAction

public FinancialEntityAction()

Method Detail

management

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

This method is called when user open the financial entity maintenance page

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

editNew

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

This method is to forward to 'New Financial Entity' page

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

editList

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

This method is to forward to 'My Financial Entities' page.

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

saveFinancialEntity

protected void saveFinancialEntity(org.apache.struts.action.ActionForm form,
                       PersonFinIntDisclosure personFinIntDisclosure)

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

This method for 'close' button action.

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

isValidToSave

protected boolean isValidToSave(PersonFinIntDisclosure personFinIntDisclosure,
                    String errorPath)

checkRule

protected boolean checkRule(KraDocumentEventBaseExtension event)

This method is to process rule check.

Parameters:

event -

Returns:

getBusinessObjectService

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

getFinancialEntityService

protected FinancialEntityService getFinancialEntityService()

getCoiDisclosureService

protected CoiDisclosureService getCoiDisclosureService()

getSequenceAccessorService

protected org.kuali.rice.krad.service.SequenceAccessorService getSequenceAccessorService()

getFinancialEntities

protected List<PersonFinIntDisclosure> getFinancialEntities(boolean active)

getFinancialEntities

protected List<PersonFinIntDisclosure> getFinancialEntities(String personId,
                                                boolean active)

recordSubmitActionSuccess

protected void recordSubmitActionSuccess(String submitAction)

This method is for header message displaying

Parameters:

submitAction -

refresh

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

This is specifically for 'sponsor' lookup' when return a value, the addresses fields will be overriden.

Overrides:

refresh in class org.kuali.rice.kns.web.struts.action.KualiAction

Throws:

Exception

See Also:

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

buildForwardUrl

protected String buildForwardUrl(String routeHeaderId)

viewFinancialEntityAttachment

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

Throws:

Exception

viewFinancialEntityAttachmentFromSummary

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

Throws:

Exception

getCoiPrintingService

protected CoiPrintingService getCoiPrintingService()

getWatermarkService

protected WatermarkService getWatermarkService()

getValidHeaderString

protected static String getValidHeaderString(String s)

buildParameterizedConfirmationQuestion

protected StrutsConfirmation buildParameterizedConfirmationQuestion(org.apache.struts.action.ActionMapping mapping,
                                                        org.apache.struts.action.ActionForm form,
                                                        javax.servlet.http.HttpServletRequest request,
                                                        javax.servlet.http.HttpServletResponse response,
                                                        String questionId,
                                                        String configurationId,
                                                        String... params)
                                                             throws Exception

"borrowed" from KraTransactionalDocumentActionBase class

Throws:

Exception

confirm

public org.apache.struts.action.ActionForward confirm(StrutsConfirmation question,
                                             String yesMethodName,
                                             String noMethodName)
                                               throws Exception

"borrowed" from KraTransactionalDocumentActionBase class

Throws:

Exception

performQuestionWithoutInput

protected org.apache.struts.action.ActionForward performQuestionWithoutInput(StrutsConfirmation question,
                                                                 String context)
                                                                      throws Exception

"borrowed" from KraTransactionalDocumentActionBase class

Throws:

Exception

confirmCancelFinancialEntity

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

Throws:

Exception

declineCancelFinancialEntity

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

Throws:

Exception

whereToGoAfterCancel

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

Throws:

Exception