DocumentOperationAction (Rice 2.3.1 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.kuali.rice.kew.documentoperation.web
Class DocumentOperationAction

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.kew.web.KewKualiAction
                      org.kuali.rice.kew.documentoperation.web.DocumentOperationAction

public class DocumentOperationAction
extends KewKualiAction
extends KewKualiAction

Struts Action for doing editing of workflow documents.

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

Field Summary

Fields inherited from class org.kuali.rice.kew.web.KewKualiAction
`DEFAULT_MAPPING`

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
`DocumentOperationAction()`

Method Summary
`org.apache.struts.action.ActionForward`	`blanketApproveDocument(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`	`clear(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.ActionMessages`	`establishRequiredState(javax.servlet.http.HttpServletRequest request, org.apache.struts.action.ActionForm form)`
`org.apache.struts.action.ActionForward`	`getDocument(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`	`indexSearchableAttributes(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`	`moveDocument(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`	`queueActionInvocation(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`	`queueDocument(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`	`queueDocumentRefresh(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`	`refresh(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)` Default refresh method.
`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)`
`org.apache.struts.action.ActionForward`	`start(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.rice.kew.web.KewKualiAction
`defaultDispatch, getDefaultMapping, getReturnLocation`

Methods inherited from class org.kuali.rice.kns.web.struts.action.KualiAction
addMethodToCallToUncheckedList, checkAuthorization, dispatchMethod, doProcessingAfterPost, execute, findMethodToCall, getApplicationBaseUrl, getBusinessObjectAuthorizationService, getEncryptionService, getHeaderTabDispatch, getHeaderTabNavigateTo, getImageContext, getKualiModuleService, getLineToDelete, getLineToEdit, getRoleQualification, getSelectedLine, getTabToToggle, headerTab, hideAllTabs, isModuleLocked, performInquiry, performLookup, performQuestionWithInput, performQuestionWithInputAgainBecauseOfErrors, performQuestionWithoutInput, performWorkgroupLookup, postTextAreaToParent, retrieveLookupParameterValue, showAllTabs, toggleTab, updateTextArea, validateLookupInquiryFullParameter

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

addMethodToCallToUncheckedList, checkAuthorization, dispatchMethod, doProcessingAfterPost, execute, findMethodToCall, getApplicationBaseUrl, getBusinessObjectAuthorizationService, getEncryptionService, getHeaderTabDispatch, getHeaderTabNavigateTo, getImageContext, getKualiModuleService, getLineToDelete, getLineToEdit, getRoleQualification, getSelectedLine, getTabToToggle, headerTab, hideAllTabs, isModuleLocked, performInquiry, performLookup, performQuestionWithInput, performQuestionWithInputAgainBecauseOfErrors, performQuestionWithoutInput, performWorkgroupLookup, postTextAreaToParent, retrieveLookupParameterValue, showAllTabs, toggleTab, 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

DocumentOperationAction

public DocumentOperationAction()

Method Detail

start

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

Overrides:: start in class KewKualiAction

Throws:: IOException; javax.servlet.ServletException

getDocument

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

Throws:: IOException; javax.servlet.ServletException

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 IOException,
                                                    javax.servlet.ServletException

Throws:: IOException; javax.servlet.ServletException

establishRequiredState

public org.apache.struts.action.ActionMessages establishRequiredState(javax.servlet.http.HttpServletRequest request,
                                                                      org.apache.struts.action.ActionForm form)
                                                               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

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 IOException,
                                                      javax.servlet.ServletException

Description copied from class: KualiAction

Default refresh method. Called from returning frameworks.

Overrides:: refresh in class KualiAction

Returns:
Throws:: IOException; javax.servlet.ServletException

queueDocument

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

Throws:: IOException; javax.servlet.ServletException

indexSearchableAttributes

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

Throws:: IOException; javax.servlet.ServletException

queueDocumentRefresh

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

Throws:: IOException; javax.servlet.ServletException

blanketApproveDocument

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

Throws:: IOException; javax.servlet.ServletException

moveDocument

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

Throws:: IOException; javax.servlet.ServletException

queueActionInvocation

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

Throws:: IOException; javax.servlet.ServletException