org.kuali.kra.common.committee.web.struts.action

Class CommitteeActionBase

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.rice.kns.web.struts.action.KualiDocumentActionBase

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

org.kuali.kra.web.struts.action.KraTransactionalDocumentActionBase

org.kuali.kra.common.committee.web.struts.action.CommitteeActionBase

Direct Known Subclasses:

CommitteeActionsActionBase, CommitteeCommitteeActionBase, CommitteeMembershipActionBase, CommitteeScheduleActionBase

public abstract class CommitteeActionBase
extends KraTransactionalDocumentActionBase

The CommitteeActionBase is the base class for all CommitteeBase actions. Each derived Action class corresponds to one tab (web page). The derived Action classes handle the user requests for a particular tab (web page).

Field Summary

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

DOCUMENT_LOAD_COMMANDS

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
CommitteeActionBase()

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	applyRules(org.kuali.rice.krad.rules.rule.event.KualiDocumentEvent event) Use the Kuali Rule Service to apply the rules for the given event.
org.apache.struts.action.ActionForward	blanketApprove(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	close(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Close the document and take the user back to the index (portal page); only after asking the user if they want to save the document first.
org.apache.struts.action.ActionForward	committee(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Go to the committee tab.
org.apache.struts.action.ActionForward	committeeActions(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Go to the committeeActions tab.
org.apache.struts.action.ActionForward	committeeMembership(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Go to the committeeMembership tab.
org.apache.struts.action.ActionForward	committeeSchedule(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Go to the committeeSchedule tab.
org.apache.struts.action.ActionForward	docHandler(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	execute(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected abstract String	getCommitteeDocumentTypeSimpleNameHook()
protected org.kuali.rice.krad.service.KualiRuleService	getKualiRuleService() Get the Kuali Rule Service.
protected abstract CommitteeTaskBase	getNewCommitteeTaskInstanceHook(String taskName, CommitteeBase committee)
protected boolean	isValidSave(CommitteeFormBase committeeForm) Can the committee be saved? This method is normally overridden by a subclass in order to invoke business rules to verify that the committee can be saved.
protected void	populateAuthorizationFields(org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase formBase)
protected void	processMultipleLookupResults(CommitteeFormBase committeeForm, Class lookupResultsBOClass, Collection<org.kuali.rice.krad.bo.PersistableBusinessObject> selectedBOs) This method must be overridden by a derived class if that derived class has a field that requires a Lookup that returns multiple values.
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) We override this method to add in support for multi-lookups.
org.apache.struts.action.ActionForward	route(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	save(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Provide hooks for subclasses to perform additional tasks related to saving the document.

Methods inherited from class org.kuali.kra.web.struts.action.KraTransactionalDocumentActionBase

buildActionUrl, buildForwardUrl, buildParameterizedConfirmationQuestion, confirm, createSuccessfulSubmitRedirect, dispatchMethod, generatePessimisticLockMessage, getValidHeaderString, headerTab, initialDocumentSave, isAuthorized, loadDocument, performQuestionWithoutInput, postDocumentSave, preDocumentSave, processAuthorizationViolation, recall, releaseLocks, reload, reloadWithoutWarning, returnToSender, routeToHoldingPage, routeToHoldingPage, saveOnClose, sendAdHocRequests, setupPessimisticLockMessages, streamToResponse

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

copy

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

acknowledge, approve, attemptLockRelease, buildAuthorizationException, cancel, cancelBOAttachment, canSave, checkAndWarnAboutSensitiveData, checkAuthorization, combineAdHocRecipients, complete, convertSetToMap, createDocument, delete, deleteAdHocRoutePerson, deleteAdHocRouteWorkgroup, deleteBONote, determineNoteWorkflowNotificationAction, disapprove, doProcessingAfterPost, downloadBOAttachment, exitingDocument, fyi, getAttachmentService, getBusinessObjectAuthorizationService, getBusinessObjectMetaDataService, getBusinessObjectService, getDataDictionaryService, getDocumentHelperService, getDocumentService, getEntityManagerFactory, getGroupService, getKualiConfigurationService, getNoteService, getParameterService, getPessimisticLockService, getQuestion, hasPendingAdhocForCompletion, hideAllTabs, insertAdHocRoutePerson, insertAdHocRouteWorkgroup, insertBONote, isFormRepresentingLockObject, performRouteReport, populateAdHocActionRequestCodes, promptBeforeValidation, promptBeforeValidation, refreshAdHocRoutingWorkgroupLookups, selectedAttachmentIndex, sendNoteWorkflowNotification, setupDocumentExit, showAllTabs, streamToResponse, superUserApprove, superUserDisapprove, supervisorFunctions, takeSuperUserActions, toggleTab

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

addMethodToCallToUncheckedList, defaultDispatch, findMethodToCall, getApplicationBaseUrl, getEncryptionService, getHeaderTabDispatch, getHeaderTabNavigateTo, getImageContext, getKualiModuleService, getLineToDelete, getLineToEdit, getReturnLocation, getRoleQualification, getSelectedLine, getTabToToggle, isModuleLocked, performInquiry, performLookup, performQuestionWithInput, performQuestionWithInputAgainBecauseOfErrors, performQuestionWithoutInput, performWorkgroupLookup, postTextAreaToParent, retrieveLookupParameterValue, 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

Constructor Detail

CommitteeActionBase

public CommitteeActionBase()

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 KraTransactionalDocumentActionBase

Throws:

Exception

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

Description copied from class: KraTransactionalDocumentActionBase

Provide hooks for subclasses to perform additional tasks related to saving the document. The optional tasks are: 1. Doing something right before the document is saved. 2. Doing something after the document has been saved for the first time only.

Overrides:

save in class KraTransactionalDocumentActionBase

Throws:

Exception

See Also:

org.kuali.core.web.struts.action.KualiDocumentActionBase#save(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

getNewCommitteeTaskInstanceHook

protected abstract CommitteeTaskBase getNewCommitteeTaskInstanceHook(String taskName,
                                                CommitteeBase committee)

isValidSave

protected boolean isValidSave(CommitteeFormBase committeeForm)

Can the committee be saved? This method is normally overridden by a subclass in order to invoke business rules to verify that the committee can be saved.

Parameters:

committeeForm - the CommitteeBase Form

Returns:

true if the committee can be saved; otherwise false

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: KraTransactionalDocumentActionBase

Close the document and take the user back to the index (portal page); only after asking the user if they want to save the document first. Only users who have the "canSave()" permission are given this option.

Overrides:

close in class KraTransactionalDocumentActionBase

Returns:

ActionForward

Throws:

Exception

See Also:

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

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

We override this method to add in support for multi-lookups.

Overrides:

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

Throws:

Exception

See Also:

org.kuali.core.web.struts.action.KualiDocumentActionBase#refresh(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

processMultipleLookupResults

protected void processMultipleLookupResults(CommitteeFormBase committeeForm,
                                Class lookupResultsBOClass,
                                Collection<org.kuali.rice.krad.bo.PersistableBusinessObject> selectedBOs)

This method must be overridden by a derived class if that derived class has a field that requires a Lookup that returns multiple values. The derived class should first check the class of the selected BOs. Based upon the class, the CommitteeBase can be updated accordingly. This is necessary since there may be more than one multi-lookup on a web page.

Parameters:

committeeForm - the CommitteeBase Form

lookupResultsBOClass - the class of the BOs that are returned by the Lookup

selectedBOs - the selected BOs

docHandler

public org.apache.struts.action.ActionForward docHandler(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:

docHandler in class KraTransactionalDocumentActionBase

Throws:

Exception

See Also:

org.kuali.core.web.struts.action.KualiDocumentActionBase#docHandler(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

committee

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

Go to the committee tab.

Parameters:

mapping -

form -

request -

response -

Returns:

committeeMembership

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

Go to the committeeMembership tab.

Parameters:

mapping -

form -

request -

response -

Returns:

committeeSchedule

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

Go to the committeeSchedule tab.

Parameters:

mapping -

form -

request -

response -

Returns:

committeeActions

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

Go to the committeeActions tab.

Parameters:

mapping -

form -

request -

response -

Returns:

getKualiRuleService

protected org.kuali.rice.krad.service.KualiRuleService getKualiRuleService()

Get the Kuali Rule Service.

Overrides:

getKualiRuleService in class org.kuali.rice.kns.web.struts.action.KualiDocumentActionBase

Returns:

the Kuali Rule Service

applyRules

protected final boolean applyRules(org.kuali.rice.krad.rules.rule.event.KualiDocumentEvent event)

Use the Kuali Rule Service to apply the rules for the given event.

Parameters:

event - the event to process

Returns:

true if success; false if there was a validation error

route

public org.apache.struts.action.ActionForward route(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:

route in class KraTransactionalDocumentActionBase

Throws:

Exception

getCommitteeDocumentTypeSimpleNameHook

protected abstract String getCommitteeDocumentTypeSimpleNameHook()

blanketApprove

public org.apache.struts.action.ActionForward blanketApprove(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:

blanketApprove in class org.kuali.rice.kns.web.struts.action.KualiDocumentActionBase

Throws:

Exception

populateAuthorizationFields

protected void populateAuthorizationFields(org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase formBase)

Overrides:

populateAuthorizationFields in class KraTransactionalDocumentActionBase

See Also:

KualiTransactionalDocumentActionBase.populateAuthorizationFields(org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase)