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

Class IdentityManagementDocumentActionBase

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

Direct Known Subclasses:

IdentityManagementGroupDocumentAction, IdentityManagementPersonDocumentAction, IdentityManagementRoleDocumentAction

public abstract class IdentityManagementDocumentActionBase
extends KualiTransactionalDocumentActionBase

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	CHANGE_MEMBER_TYPE_CODE_METHOD_TO_CALL
protected static String	CHANGE_NAMESPACE_METHOD_TO_CALL
protected IdentityService	identityService
protected ResponsibilityService	responsibilityService
protected UiDocumentService	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
IdentityManagementDocumentActionBase()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	applyPagingAndSortingFromPreviousPageView(IdentityManagementDocumentFormBase idmForm)
org.apache.struts.action.ActionForward	changeNamespace(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	getActionName()
protected org.apache.struts.action.ActionForward	getBasePathForward(javax.servlet.http.HttpServletRequest request, org.apache.struts.action.ActionForward forward)
protected IdentityService	getIdentityService()
protected KimTypeService	getKimTypeService(KimType typeInfo)
protected ResponsibilityService	getResponsibilityService()
protected String	getReturnLocation(javax.servlet.http.HttpServletRequest request, org.apache.struts.action.ActionMapping mapping)
protected UiDocumentService	getUiDocumentService()
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) Takes care of storing the action form in the User session and forwarding to the lookup action.
protected org.apache.struts.action.ActionForward	returnToSender(javax.servlet.http.HttpServletRequest request, org.apache.struts.action.ActionMapping mapping, KualiDocumentFormBase form) If the given form has returnToActionList set to true, this method returns an ActionForward that should take the user back to their action list; otherwise, it returns them to the portal.
org.apache.struts.action.ActionForward	switchToPage(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected boolean	validateRole(String roleId, Role role, String propertyName, String message)

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, createDocument, delete, deleteAdHocRoutePerson, deleteAdHocRouteWorkgroup, deleteBONote, determineNoteWorkflowNotificationAction, disapprove, docHandler, doProcessingAfterPost, downloadBOAttachment, execute, exitingDocument, fyi, generatePessimisticLockMessage, getAttachmentService, getBusinessObjectAuthorizationService, getBusinessObjectMetaDataService, getBusinessObjectService, getDataDictionaryService, getDocumentHelperService, getDocumentService, getEntityManagerFactory, getGroupService, getKualiConfigurationService, getKualiRuleService, getNoteService, getParameterService, getPessimisticLockService, getQuestion, hasPendingAdhocForCompletion, hideAllTabs, insertAdHocRoutePerson, insertAdHocRouteWorkgroup, insertBONote, isFormRepresentingLockObject, loadDocument, 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_MEMBER_TYPE_CODE_METHOD_TO_CALL

protected static final String CHANGE_MEMBER_TYPE_CODE_METHOD_TO_CALL

See Also:

Constant Field Values

CHANGE_NAMESPACE_METHOD_TO_CALL

protected static final String CHANGE_NAMESPACE_METHOD_TO_CALL

See Also:

Constant Field Values

identityService

protected IdentityService identityService

responsibilityService

protected ResponsibilityService responsibilityService

uiDocumentService

protected UiDocumentService uiDocumentService

Constructor Detail

IdentityManagementDocumentActionBase

public IdentityManagementDocumentActionBase()

Method Detail

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

Description copied from class: KualiAction

Takes care of storing the action form in the User session and forwarding to the lookup action.

Overrides:

performLookup in class KualiAction

Returns:

Throws:

Exception

getActionName

protected abstract String getActionName()

getIdentityService

protected IdentityService getIdentityService()

getResponsibilityService

protected ResponsibilityService getResponsibilityService()

getUiDocumentService

protected UiDocumentService getUiDocumentService()

getReturnLocation

protected String getReturnLocation(javax.servlet.http.HttpServletRequest request,
                       org.apache.struts.action.ActionMapping mapping)

Overrides:

getReturnLocation in class KualiAction

returnToSender

protected org.apache.struts.action.ActionForward returnToSender(javax.servlet.http.HttpServletRequest request,
                                                    org.apache.struts.action.ActionMapping mapping,
                                                    KualiDocumentFormBase form)

Description copied from class: KualiDocumentActionBase

If the given form has returnToActionList set to true, this method returns an ActionForward that should take the user back to their action list; otherwise, it returns them to the portal.

Overrides:

returnToSender in class KualiDocumentActionBase

Returns:

getBasePathForward

protected org.apache.struts.action.ActionForward getBasePathForward(javax.servlet.http.HttpServletRequest request,
                                                        org.apache.struts.action.ActionForward forward)

switchToPage

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

applyPagingAndSortingFromPreviousPageView

protected void applyPagingAndSortingFromPreviousPageView(IdentityManagementDocumentFormBase idmForm)

validateRole

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

changeNamespace

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

getKimTypeService

protected KimTypeService getKimTypeService(KimType typeInfo)