org.kuali.rice.kim.web.struts.action

Class IdentityManagementPersonDocumentAction

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.rice.kim.web.struts.action.IdentityManagementDocumentActionBase

org.kuali.rice.kim.web.struts.action.IdentityManagementPersonDocumentAction

public class IdentityManagementPersonDocumentAction
extends IdentityManagementDocumentActionBase

This is a description of what this class does - shyu don't forget to fill this in.

Author:

Kuali Rice Team (rice.collab@kuali.org)

Field Summary

Fields

Modifier and Type	Field and Description
protected ResponsibilityInternalService	responsibilityInternalService

Fields inherited from class org.kuali.rice.kim.web.struts.action.IdentityManagementDocumentActionBase

CHANGE_MEMBER_TYPE_CODE_METHOD_TO_CALL, CHANGE_NAMESPACE_METHOD_TO_CALL, identityService, responsibilityService, uiDocumentService

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

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.struts.action.ActionForward	addAddress(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	addAffln(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	addCitizenship(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	addDelegationMember(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	addEmail(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	addEmpInfo(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	addGroup(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	addName(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	addPhone(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	addRole(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	addRoleQualifier(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected void	createDocument(KualiDocumentFormBase form) This method creates a new document of the type specified by the docTypeName property of the given form.
org.apache.struts.action.ActionForward	deleteAddress(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	deleteAffln(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	deleteCitizenship(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	deleteDelegationMember(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	deleteEmail(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	deleteEmpInfo(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	deleteGroup(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	deleteName(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	deletePhone(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	deleteRole(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	deleteRoleQualifier(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) Entry point to all actions.
String	getActionName()
ResponsibilityInternalService	getResponsibilityInternalService()
protected String	getSelectedParentChildIdx(javax.servlet.http.HttpServletRequest request)
protected void	loadDocument(KualiDocumentFormBase form) This method loads the document by its provided document header id.
protected void	populateRoleInformation(IdentityManagementPersonDocument personDoc)
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) if the action desires to retain error messages generated by the rules framework for save/submit/etc.
protected org.apache.struts.action.ActionForward	refreshAfterDelegationMemberRoleSelection(org.apache.struts.action.ActionMapping mapping, IdentityManagementPersonDocumentForm impdForm, javax.servlet.http.HttpServletRequest request)
protected org.apache.struts.action.ActionForward	renderRoleMemberSelection(org.apache.struts.action.ActionMapping mapping, javax.servlet.http.HttpServletRequest request, IdentityManagementPersonDocumentForm impdForm)
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) This method will save the document, which will then be available via the action list for the person who saved the document.
protected void	setAttrDefnIdForQualifier(KimDocumentRoleQualifier qualifier, KimAttributeField definition)
protected void	setupRoleRspActions(PersonDocumentRole role, KimDocumentRoleMember rolePrncpl)
protected boolean	validateRoleAssignment(IdentityManagementPersonDocument document, PersonDocumentRole newRole)

Methods inherited from class org.kuali.rice.kim.web.struts.action.IdentityManagementDocumentActionBase

applyPagingAndSortingFromPreviousPageView, changeNamespace, getBasePathForward, getIdentityService, getKimTypeService, getResponsibilityService, getReturnLocation, getUiDocumentService, performLookup, returnToSender, switchToPage, validateRole

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

copy, populateAuthorizationFields

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

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

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

addMethodToCallToUncheckedList, defaultDispatch, dispatchMethod, findMethodToCall, getApplicationBaseUrl, getEncryptionService, getHeaderTabDispatch, getHeaderTabNavigateTo, getImageContext, getKualiModuleService, getLineToDelete, getLineToEdit, getRoleQualification, getSelectedLine, getTabToToggle, headerTab, 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

Field Detail

responsibilityInternalService

protected ResponsibilityInternalService responsibilityInternalService

Constructor Detail

IdentityManagementPersonDocumentAction

public IdentityManagementPersonDocumentAction()

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

Description copied from class: KualiDocumentActionBase

Entry point to all actions.

NOTE: No need to hook into execute for handling framwork setup anymore. Just implement the methodToCall for the framework setup, Constants.METHOD_REQUEST_PARAMETER will contain the full parameter, which can be sub stringed for getting framework parameters.

Overrides:

execute in class KualiDocumentActionBase

Throws:

Exception

See Also:

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

loadDocument

protected void loadDocument(KualiDocumentFormBase form)
                     throws WorkflowException

Description copied from class: KualiDocumentActionBase

This method loads the document by its provided document header id. This has been abstracted out so that it can be overridden in children if the need arises.

Overrides:

loadDocument in class KualiDocumentActionBase

Throws:

WorkflowException

populateRoleInformation

protected void populateRoleInformation(IdentityManagementPersonDocument personDoc)

createDocument

protected void createDocument(KualiDocumentFormBase form)
                       throws WorkflowException

Description copied from class: KualiDocumentActionBase

This method creates a new document of the type specified by the docTypeName property of the given form. This has been abstracted out so that it can be overridden in children if the need arises.

Overrides:

createDocument in class KualiDocumentActionBase

Throws:

WorkflowException

getActionName

public String getActionName()

Specified by:

getActionName in class IdentityManagementDocumentActionBase

See Also:

IdentityManagementDocumentActionBase.getActionName()

addAffln

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

deleteAffln

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

addCitizenship

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

deleteCitizenship

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

addEmpInfo

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

deleteEmpInfo

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

getSelectedParentChildIdx

protected String getSelectedParentChildIdx(javax.servlet.http.HttpServletRequest request)

addName

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

deleteName

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

addAddress

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

deleteAddress

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

addPhone

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

deletePhone

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

addEmail

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

deleteEmail

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

addGroup

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

deleteGroup

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

addRole

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

validateRoleAssignment

protected boolean validateRoleAssignment(IdentityManagementPersonDocument document,
                             PersonDocumentRole newRole)

setupRoleRspActions

protected void setupRoleRspActions(PersonDocumentRole role,
                       KimDocumentRoleMember rolePrncpl)

setAttrDefnIdForQualifier

protected void setAttrDefnIdForQualifier(KimDocumentRoleQualifier qualifier,
                             KimAttributeField definition)

deleteRole

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

addRoleQualifier

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

deleteRoleQualifier

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

addDelegationMember

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

deleteDelegationMember

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

This method will save the document, which will then be available via the action list for the person who saved the document.

Overrides:

save in class KualiDocumentActionBase

Returns:

ActionForward

Throws:

Exception

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

Description copied from class: KualiDocumentActionBase

if the action desires to retain error messages generated by the rules framework for save/submit/etc. validation after returning from a lookup.

Overrides:

refresh in class KualiDocumentActionBase

Returns:

Throws:

Exception

See Also:

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

refreshAfterDelegationMemberRoleSelection

protected org.apache.struts.action.ActionForward refreshAfterDelegationMemberRoleSelection(org.apache.struts.action.ActionMapping mapping,
                                                                               IdentityManagementPersonDocumentForm impdForm,
                                                                               javax.servlet.http.HttpServletRequest request)

renderRoleMemberSelection

protected org.apache.struts.action.ActionForward renderRoleMemberSelection(org.apache.struts.action.ActionMapping mapping,
                                                               javax.servlet.http.HttpServletRequest request,
                                                               IdentityManagementPersonDocumentForm impdForm)

getResponsibilityInternalService

public ResponsibilityInternalService getResponsibilityInternalService()