Hyperic HQ Plugin API v. 4.4.0.2

org.hyperic.hq.ui.action
Class WorkflowAction

java.lang.Object
  extended by org.apache.struts.action.Action
      extended by org.hyperic.hq.ui.action.BaseAction
          extended by org.hyperic.hq.ui.action.WorkflowAction

public abstract class WorkflowAction
extends BaseAction

This Action is designed to be part of a workflow, saving it's current return path in the workflow stack.


Field Summary
 
Fields inherited from class org.hyperic.hq.ui.action.BaseAction
NO_RETURN_PATH, YES_RETURN_PATH
 
Fields inherited from class org.apache.struts.action.Action
servlet
 
Constructor Summary
WorkflowAction()
           
 
Method Summary
 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)
          Starts workflow by taking what is currently stored in the session as returnPath (one of many possible origins of this workflow), and pushing it onto our workflow stack.
abstract  org.apache.struts.action.ActionForward workflow(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          To participate in a workflow, simply implement this the same as you would execute().
 
Methods inherited from class org.hyperic.hq.ui.action.BaseAction
checkSubmit, checkSubmit, checkSubmit, checkSubmit, checkSubmit, checkSubmit, constructForward, constructForward, constructForward, constructForward, execute, returnAdd, returnAdd, returnAdd, returnCancelled, returnCancelled, returnCancelled, returnCancelled, returnFailure, returnFailure, returnFailure, returnFailure, returnFailure, returnNew, returnNew, returnNew, returnNew, returnNew, returnOkAssign, returnOkAssign, returnRemove, returnRemove, returnRemove, returnReset, returnReset, returnReset, returnReset, returnSuccess, returnSuccess, returnSuccess, returnSuccess, returnSuccess
 
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

WorkflowAction

public WorkflowAction()
Method Detail

execute

public final 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 java.lang.Exception
Starts workflow by taking what is currently stored in the session as returnPath (one of many possible origins of this workflow), and pushing it onto our workflow stack. Passes call to workflow() so that the child class can overload.

Overrides:
execute in class BaseAction
Throws:
java.lang.Exception

workflow

public abstract org.apache.struts.action.ActionForward workflow(org.apache.struts.action.ActionMapping mapping,
                                                                org.apache.struts.action.ActionForm form,
                                                                javax.servlet.http.HttpServletRequest request,
                                                                javax.servlet.http.HttpServletResponse response)
                                                         throws java.lang.Exception
To participate in a workflow, simply implement this the same as you would execute(). This will be called by SpiderWorkfowActions's execute() method after it saves the workflow context.

Throws:
java.lang.Exception

Hyperic HQ Plugin API v. 4.4.0.2

Copyright © 2004-2006 Hyperic, Inc. support@hyperic.net, All Rights Reserved.