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

Class CommitteeMembershipActionBase

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

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

Direct Known Subclasses:

CommitteeMembershipAction, IacucCommitteeMembershipAction

public abstract class CommitteeMembershipActionBase
extends CommitteeActionBase

The CommitteeMembershipActionBase corresponds to the Members tab (web page). It is responsible for handling all user requests from that 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
CommitteeMembershipActionBase()

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.struts.action.ActionForward	addCommitteeMembership(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method perform the action - Add CommitteeBase Membership.
org.apache.struts.action.ActionForward	addCommitteeMembershipRole(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 linked to CommitteeMembershipService to perform the action.
org.apache.struts.action.ActionForward	clearCommitteeMembership(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 clears the CommitteeMembershipBase selection.
org.apache.struts.action.ActionForward	deleteCommitteeMembership(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 perform the action - Delete CommitteeBase Membership.
org.apache.struts.action.ActionForward	deleteCommitteeMembershipExpertise(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 linked to CommitteeMembershipService to perform the action.
org.apache.struts.action.ActionForward	deleteCommitteeMembershipRole(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 linked to CommitteeMembershipService to perform the action.
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 Class<? extends CommitteeMembershipServiceBase>	getCommitteeMembershipServiceClassHook()
protected abstract CommitteeDocumentRuleBase	getNewCommitteeDocumentRuleInstanceHook()
protected abstract CommitteeMembershipBase	getNewCommitteeMembershipInstanceHook()
protected abstract DeleteCommitteeMemberEventBase	getNewDeleteCommitteeMemberEventInstanceHook(String errorPathPrefix, org.kuali.rice.krad.document.Document document, List<CommitteeMembershipBase> committeeMemberships, CommitteeMemberEventBase.ErrorType type)
protected abstract Class<? extends ResearchAreaBase>	getResearchAreaBOClassHook()
protected int	getSelectedMembershipIndex(javax.servlet.http.HttpServletRequest request) This method is to get selected membership index.
org.apache.struts.action.ActionForward	performLookup(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected void	processMultipleLookupResults(CommitteeFormBase committeeForm, Class lookupResultsBOClass, Collection<org.kuali.rice.krad.bo.PersistableBusinessObject> selectedBOs) This method is linked to CommitteeMembershipService to perform the action.
org.apache.struts.action.ActionForward	reload(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	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.
org.apache.struts.action.ActionForward	showActiveMembersOnly(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	showAllMembers(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.kra.common.committee.web.struts.action.CommitteeActionBase

applyRules, blanketApprove, close, committee, committeeActions, committeeMembership, committeeSchedule, docHandler, getCommitteeDocumentTypeSimpleNameHook, getKualiRuleService, getNewCommitteeTaskInstanceHook, isValidSave, populateAuthorizationFields, refresh

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

CommitteeMembershipActionBase

public CommitteeMembershipActionBase()

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 CommitteeActionBase

Throws:

Exception

See Also:

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

addCommitteeMembership

public org.apache.struts.action.ActionForward addCommitteeMembership(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 perform the action - Add CommitteeBase Membership. Method is called in committeeAddCommitteeMembership.tag; rules are validated and if passed the committee member is added.

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

getNewCommitteeMembershipInstanceHook

protected abstract CommitteeMembershipBase getNewCommitteeMembershipInstanceHook()

deleteCommitteeMembership

public org.apache.struts.action.ActionForward deleteCommitteeMembership(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 perform the action - Delete CommitteeBase Membership. Method is called in CommitteeMembershipBase.jsp

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

getNewDeleteCommitteeMemberEventInstanceHook

protected abstract DeleteCommitteeMemberEventBase getNewDeleteCommitteeMemberEventInstanceHook(String errorPathPrefix,
                                                                          org.kuali.rice.krad.document.Document document,
                                                                          List<CommitteeMembershipBase> committeeMemberships,
                                                                          CommitteeMemberEventBase.ErrorType type)

clearCommitteeMembership

public org.apache.struts.action.ActionForward clearCommitteeMembership(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 clears the CommitteeMembershipBase selection. Method is called in committeeAddCommitteeMembership.tag

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

addCommitteeMembershipRole

public org.apache.struts.action.ActionForward addCommitteeMembershipRole(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 linked to CommitteeMembershipService to perform the action. Add a CommitteeMembershipRole to a CommitteeMembershipBase. Method is called in committeeMembershipRoleSection.tag

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

deleteCommitteeMembershipRole

public org.apache.struts.action.ActionForward deleteCommitteeMembershipRole(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 linked to CommitteeMembershipService to perform the action. Delete a CommitteeMembershipRole from a CommitteeMembershipBase. Method is called in committeeMembershipRoleSection.tag

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

performLookup

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

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

Throws:

Exception

See Also:

org.kuali.core.web.struts.action.KualiAction#performLookup(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 is linked to CommitteeMembershipService to perform the action. Add CommitteeMembershipExpertise to a CommitteeMembershipBase. Method is called in committeeMembershipExpertiseSection.tag

Overrides:

processMultipleLookupResults in class CommitteeActionBase

Parameters:

mapping -

form -

request -

response -

Throws:

Exception

getResearchAreaBOClassHook

protected abstract Class<? extends ResearchAreaBase> getResearchAreaBOClassHook()

getNewCommitteeDocumentRuleInstanceHook

protected abstract CommitteeDocumentRuleBase getNewCommitteeDocumentRuleInstanceHook()

deleteCommitteeMembershipExpertise

public org.apache.struts.action.ActionForward deleteCommitteeMembershipExpertise(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 linked to CommitteeMembershipService to perform the action. Delete a CommitteeMembershipExpertise from a CommitteeMembershipBase. Method is called in committeeMembershipExpertiseSection.tag

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

getCommitteeMembershipServiceClassHook

protected abstract Class<? extends CommitteeMembershipServiceBase> getCommitteeMembershipServiceClassHook()

getSelectedMembershipIndex

protected int getSelectedMembershipIndex(javax.servlet.http.HttpServletRequest request)

This method is to get selected membership index. Each membership data is displayed in individual panel. Membership index is required to identify the membership to perform an action.

Parameters:

request -

Returns:

index

showAllMembers

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

showActiveMembersOnly

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

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 CommitteeActionBase

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)

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 CommitteeActionBase

Throws:

Exception

reload

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

reload in class KraTransactionalDocumentActionBase

Throws:

Exception