com.ibm.workflow.portlet.client
Class MQWFListPortlet

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.MQWFListPortlet
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 MQWFListPortlet
extends MQWFBasePortlet
implements org.apache.jetspeed.portlet.event.ActionListener, org.apache.jetspeed.portlet.event.MessageListener

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
MQWFListPortlet()
           
 
Method Summary
 void actionPerformed(org.apache.jetspeed.portlet.event.ActionEvent event)
          This method will trigger the page identification or the processing of the workflow request by an action type user portlet instance.
 void checkStatus(org.apache.jetspeed.portlet.PortletRequest request, ResponsePage result)
          Will tidy up the NO_FREE_ACTION_INSTANCE attribute of the RequestContext object out of the ResponsePage object and set this attribute again in case of an error.
 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)
          Callback method of MessageListener.
 void performCancelAction(org.apache.jetspeed.portlet.event.ActionEvent event)
          Makes the instance show the most recent list again.
 void performListAction(org.apache.jetspeed.portlet.event.ActionEvent event)
          This action will be transmitted by the links in the ComboBox of a list.
 void performListRefresh(org.apache.jetspeed.portlet.PortletRequest request)
          Will generate the model for the current view again by generation the list again based on the information contained in the session.
 void receivedListRefreshRequest(ListRefreshRequest message, org.apache.jetspeed.portlet.PortletRequest requestOfThisInstance)
          Triggers a list refresh due to a received ListRefreshRequest message
 
Methods inherited from class com.ibm.workflow.portlet.client.MQWFBasePortlet
init, login, logout, 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

MQWFListPortlet

public MQWFListPortlet()
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

performListRefresh

public void performListRefresh(org.apache.jetspeed.portlet.PortletRequest request)
Will generate the model for the current view again by generation the list again based on the information contained in the session. In the portlet case we should not make use of the mostRecentList method of the RequestContext which chooses the list based on the kindOfList flag of the containing SessionContextImpl object. As the SessionContextImpl object is managed by the SessionTable, one would get the most recently generated list in all instances.
Parameters:
PortletRequest - The PortletRequest object

performCancelAction

public void performCancelAction(org.apache.jetspeed.portlet.event.ActionEvent event)
Makes the instance show the most recent list again.
Overrides:
performCancelAction in class MQWFBasePortlet
Parameters:
event - The ActionEvent as received by actionPerformed

receivedListRefreshRequest

public void receivedListRefreshRequest(ListRefreshRequest message,
                                       org.apache.jetspeed.portlet.PortletRequest requestOfThisInstance)
Triggers a list refresh due to a received ListRefreshRequest message
Parameters:
message - The received ListRefreshRequest message
request - The PortletRequest of this instance

performListAction

public void performListAction(org.apache.jetspeed.portlet.event.ActionEvent event)
This action will be transmitted by the links in the ComboBox of a list.

actionPerformed

public void actionPerformed(org.apache.jetspeed.portlet.event.ActionEvent event)
                     throws org.apache.jetspeed.portlet.PortletException
This method will trigger the page identification or the processing of the workflow request by an action type user portlet instance. The return value of the pageIdentification method signals whether the page identification was invoked or not. If the page identification process was triggered the workflow request cannot be immediately done as the registration map is not updated yet. Instead the workflow request will be triggered during the reception of the first EchoPageMessage. Follow on requests result in a MQWFMessage sent to appropriate Actiontype Portlets.
Specified by:
actionPerformed in interface org.apache.jetspeed.portlet.event.ActionListener

checkStatus

public void checkStatus(org.apache.jetspeed.portlet.PortletRequest request,
                        ResponsePage result)
Will tidy up the NO_FREE_ACTION_INSTANCE attribute of the RequestContext object out of the ResponsePage object and set this attribute again in case of an error. An error as occured if and only if the NO_FREE_ACTION_INSTANCE is set.
Parameters:
request - The PortletRequest object.
result - The ResponsePage object.

doView

public void doView(org.apache.jetspeed.portlet.PortletRequest request,
                   org.apache.jetspeed.portlet.PortletResponse response)
            throws java.io.IOException,
                   org.apache.jetspeed.portlet.PortletException
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

messageReceived

public void messageReceived(org.apache.jetspeed.portlet.event.MessageEvent event)
Callback method of MessageListener.
Specified by:
messageReceived in interface org.apache.jetspeed.portlet.event.MessageListener
Parameters:
event -  


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