com.ibm.workflow.portlet.client
Class MQWFActionPortlet

java.lang.Object
  |
  +--javax.servlet.GenericServlet
        |
        +--javax.servlet.http.HttpServlet
              |
              +--com.ibm.wps.portletcontainer.cache.CacheablePortlet
                    |
                    +--org.apache.jetspeed.portlet.Portlet
                          |
                          +--org.apache.jetspeed.portlet.PortletAdapter
                                |
                                +--com.ibm.workflow.portlet.client.MQWFBasePortlet
                                      |
                                      +--com.ibm.workflow.portlet.client.MQWFActionPortlet
All Implemented Interfaces:
org.apache.jetspeed.portlet.event.ActionListener, com.ibm.websphere.servlet.cache.CacheableServlet, org.apache.jetspeed.portlet.event.MessageListener, MQWFPortletConstants, org.apache.jetspeed.portlet.PortletSessionListener, java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public class MQWFActionPortlet
extends MQWFBasePortlet
implements org.apache.jetspeed.portlet.event.MessageListener, org.apache.jetspeed.portlet.event.ActionListener

See Also:
Serialized Form

Inner classes inherited from class org.apache.jetspeed.portlet.Portlet
org.apache.jetspeed.portlet.Portlet.Mode, org.apache.jetspeed.portlet.Portlet.ModeModifier, org.apache.jetspeed.portlet.Portlet.PortletSessionStub
 
Fields inherited from interface com.ibm.workflow.portlet.client.MQWFPortletConstants
ACTION, ACTION_NAME, COMMAND, DONE, ID, LIST_ITEM_ID, MAX_NUMBER, MQWFPORTLETMESSAGE, nameOfAbstractActionPortlet, nameOfAbstractListPortlet, nameOfJSP, NO_FREE_ACTION_INSTANCE, PAGE, PORTLET_DATA, PREFERENCES, REG_MAP, REQUEST_PREFERENCES, UseCredentialVault, USER_DEFINED_COMMANDS, WORKFLOW_REQUEST
 
Constructor Summary
MQWFActionPortlet()
           
 
Method Summary
 void actionPerformed(org.apache.jetspeed.portlet.event.ActionEvent event)
           
 void checkResponsePageStatus(org.apache.jetspeed.portlet.PortletRequest request, ResponsePage result)
          Release instance if trivial page is shown.
 void doEdit(org.apache.jetspeed.portlet.PortletRequest request, org.apache.jetspeed.portlet.PortletResponse response)
           
 void doHelp(org.apache.jetspeed.portlet.PortletRequest request, org.apache.jetspeed.portlet.PortletResponse response)
           
 void doView(org.apache.jetspeed.portlet.PortletRequest request, org.apache.jetspeed.portlet.PortletResponse response)
           
 int getType()
          Returns the Type of the portlet as defined in RegistrationMap.
 void messageReceived(org.apache.jetspeed.portlet.event.MessageEvent event)
           
 void performEditAction(org.apache.jetspeed.portlet.event.ActionEvent event)
          Enable users to set preferences for their action type portlets (kind of requests to handle, etc.).
 void performFreeAction(org.apache.jetspeed.portlet.event.ActionEvent event)
          This method executes the given command and releases the Portlet instance subsequently.
 void performSelectAction(org.apache.jetspeed.portlet.event.ActionEvent event)
          This method executes the given command but does not release the Portlet instance subsequently.
 void receivedActionRefreshRequest(org.apache.jetspeed.portlet.event.MessageEvent event)
          Does check whether the view of this instance is not valid any more.
 
Methods inherited from class com.ibm.workflow.portlet.client.MQWFBasePortlet
init, login, logout, performCancelAction, performCredentialAction
 
Methods inherited from class org.apache.jetspeed.portlet.PortletAdapter
destroy, destroyConcrete, doConfigure, getLastModified, getPortletConfig, getPortletLog, getVariable, initConcrete, removeVariable, service, setVariable
 
Methods inherited from class org.apache.jetspeed.portlet.Portlet
destroy, getAllPortletsLinkedWithSession, getInitParameter, getInitParameterNames, getPortletLinkedWithSession, getPortletLinkedWithSession, getServletConfig, getServletContext, getServletInfo, init, init, service
 
Methods inherited from class com.ibm.wps.portletcontainer.cache.CacheablePortlet
getId, getSharingPolicy
 
Methods inherited from class javax.servlet.GenericServlet
getServletName, log, log
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MQWFActionPortlet

public MQWFActionPortlet()
Method Detail

getType

public int getType()
Description copied from class: MQWFBasePortlet
Returns the Type of the portlet as defined in RegistrationMap.
Overrides:
getType in class MQWFBasePortlet

performFreeAction

public void performFreeAction(org.apache.jetspeed.portlet.event.ActionEvent event)
This method executes the given command and releases the Portlet instance subsequently.

performEditAction

public void performEditAction(org.apache.jetspeed.portlet.event.ActionEvent event)
Enable users to set preferences for their action type portlets (kind of requests to handle, etc.).

receivedActionRefreshRequest

public void receivedActionRefreshRequest(org.apache.jetspeed.portlet.event.MessageEvent event)
Does check whether the view of this instance is not valid any more. This could happen due to a CheckOut request that is canceled using the list instead of this instance. Basically this method determines whether it is affected by calling ActionRefreshMessage.isAffected(...) and removes the ResponsePage object from the session and releases this instance.
Parameters:
MessageEvent - The MessageEvent which contains the ActionRefreshMessage

performSelectAction

public void performSelectAction(org.apache.jetspeed.portlet.event.ActionEvent event)
This method executes the given command but does not release the Portlet instance subsequently. Select is the default hardcoded into SessionContextImpl.

actionPerformed

public void actionPerformed(org.apache.jetspeed.portlet.event.ActionEvent event)
                     throws org.apache.jetspeed.portlet.PortletException
Specified by:
actionPerformed in interface org.apache.jetspeed.portlet.event.ActionListener

messageReceived

public void messageReceived(org.apache.jetspeed.portlet.event.MessageEvent event)
Specified by:
messageReceived in interface org.apache.jetspeed.portlet.event.MessageListener

checkResponsePageStatus

public void checkResponsePageStatus(org.apache.jetspeed.portlet.PortletRequest request,
                                    ResponsePage result)
Release instance if trivial page is shown. This is a fix necessary for commands like createAndStartInstance that may or may not show a nontrivial page as reaction to the command. A nontrivial page is a page not equal to ViewNotUsed.jsp for the DefaultViewer JspPortletViewer.
Parameters:
request - The PortletRequest object.
result - The ResponsePage result.

doView

public void doView(org.apache.jetspeed.portlet.PortletRequest request,
                   org.apache.jetspeed.portlet.PortletResponse response)
            throws org.apache.jetspeed.portlet.PortletException,
                   java.io.IOException
Overrides:
doView in class org.apache.jetspeed.portlet.PortletAdapter

doEdit

public void doEdit(org.apache.jetspeed.portlet.PortletRequest request,
                   org.apache.jetspeed.portlet.PortletResponse response)
            throws java.io.IOException,
                   org.apache.jetspeed.portlet.PortletException
Overrides:
doEdit in class org.apache.jetspeed.portlet.PortletAdapter

doHelp

public void doHelp(org.apache.jetspeed.portlet.PortletRequest request,
                   org.apache.jetspeed.portlet.PortletResponse response)
            throws java.io.IOException
Overrides:
doHelp in class org.apache.jetspeed.portlet.PortletAdapter


© Copyright IBM Corporation 2002, 2007. All Rights Reserved.