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

Class IdentityManagementRoleDocumentAction

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.IdentityManagementRoleDocumentAction

public class IdentityManagementRoleDocumentAction
extends IdentityManagementDocumentActionBase

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	CHANGE_DEL_ROLE_MEMBER_METHOD_TO_CALL
protected List<String>	methodToCallToUncheckedList
static String	REMOVE_AFFECTED_DELEGATES_QUESTION_ID
static String	SWITCH_TO_ROLE_MEMBER_METHOD_TO_CALL

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
IdentityManagementRoleDocumentAction() This constructs a ...

Method Summary

Methods

Modifier and Type	Method and Description
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	addMember(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	addPermission(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	addResponsibility(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	changeDelegationMemberTypeCode(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	changeMemberTypeCode(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected boolean	checkDelegationMember(RoleDocumentDelegationMember newMember)
protected boolean	checkKimDocumentRoleMember(KimDocumentRoleMember newMember)
protected String	checkMemberFullName(String principalId)
org.apache.struts.action.ActionForward	clear(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 overridden method ...
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	deleteMember(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	deletePermission(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	deleteResponsibility(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	editMember(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	editSearchResultsMember(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()
protected String	getDelegationRoleMemberToJumpTo(javax.servlet.http.HttpServletRequest request)
org.apache.struts.action.ActionForward	jumpToRoleMember(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected void	loadDocument(KualiDocumentFormBase form) This overridden method ...
protected void	loadRoleIntoDocument(String roleId, IdentityManagementRoleDocumentForm roleDocumentForm)
org.apache.struts.action.ActionForward	search(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected void	setKimType(String kimTypeId, IdentityManagementRoleDocumentForm roleDocumentForm)
org.apache.struts.action.ActionForward	sort(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected boolean	validAssignRole(IdentityManagementRoleDocument document)
protected boolean	validateRole(String roleId, Role role, String propertyName, String message) This method overrides validateRole() from IdentityManagementDocumentActionBase.

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

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

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, refresh, refreshAdHocRoutingWorkgroupLookups, releaseLocks, reload, route, save, 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

CHANGE_DEL_ROLE_MEMBER_METHOD_TO_CALL

public static final String CHANGE_DEL_ROLE_MEMBER_METHOD_TO_CALL

See Also:

Constant Field Values

SWITCH_TO_ROLE_MEMBER_METHOD_TO_CALL

public static final String SWITCH_TO_ROLE_MEMBER_METHOD_TO_CALL

See Also:

Constant Field Values

REMOVE_AFFECTED_DELEGATES_QUESTION_ID

public static final String REMOVE_AFFECTED_DELEGATES_QUESTION_ID

See Also:

Constant Field Values

methodToCallToUncheckedList

protected List<String> methodToCallToUncheckedList

Constructor Detail

IdentityManagementRoleDocumentAction

public IdentityManagementRoleDocumentAction()

This constructs a ...

Method Detail

sort

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

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

This overridden method ...

Overrides:

loadDocument in class KualiDocumentActionBase

Throws:

WorkflowException

See Also:

org.kuali.rice.krad.web.struts.action.KualiDocumentActionBase#loadDocument(org.kuali.rice.krad.web.struts.form.KualiDocumentFormBase)

createDocument

protected void createDocument(KualiDocumentFormBase form)
                       throws WorkflowException

This overridden method ...

Overrides:

createDocument in class KualiDocumentActionBase

Throws:

WorkflowException

See Also:

org.kuali.rice.krad.web.struts.action.KualiDocumentActionBase#createDocument(org.kuali.rice.krad.web.struts.form.KualiDocumentFormBase)

setKimType

protected void setKimType(String kimTypeId,
              IdentityManagementRoleDocumentForm roleDocumentForm)

loadRoleIntoDocument

protected void loadRoleIntoDocument(String roleId,
                        IdentityManagementRoleDocumentForm roleDocumentForm)

getActionName

public String getActionName()

Specified by:

getActionName in class IdentityManagementDocumentActionBase

See Also:

IdentityManagementDocumentActionBase.getActionName()

validAssignRole

protected boolean validAssignRole(IdentityManagementRoleDocument document)

changeMemberTypeCode

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

changeDelegationMemberTypeCode

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

addResponsibility

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

deleteResponsibility

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

addPermission

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

addMember

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

checkMemberFullName

protected String checkMemberFullName(String principalId)

checkKimDocumentRoleMember

protected boolean checkKimDocumentRoleMember(KimDocumentRoleMember newMember)

deleteMember

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

editMember

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

editSearchResultsMember

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

search

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

clear

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

deletePermission

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

checkDelegationMember

protected boolean checkDelegationMember(RoleDocumentDelegationMember newMember)

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

jumpToRoleMember

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

See Also:

KualiTableRenderAction.switchToPage(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

getDelegationRoleMemberToJumpTo

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

validateRole

protected boolean validateRole(String roleId,
                   Role role,
                   String propertyName,
                   String message)

This method overrides validateRole() from IdentityManagementDocumentActionBase. The difference with this method is that it allows derived roles. The base implementation returns false if the role is a derived role.

Overrides:

validateRole in class IdentityManagementDocumentActionBase