com.filenet.wcm.apps.server.ui
Class WorkflowExpressionModule

java.lang.Object
  extended bycom.filenet.wcm.toolkit.server.base.WcmDpContainer
      extended bycom.filenet.wcm.toolkit.server.base.WcmModule
          extended bycom.filenet.wcm.toolkit.server.base.GlobalEventModule
              extended bycom.filenet.wcm.toolkit.server.base.WcmUiModule
                  extended bycom.filenet.wcm.toolkit.server.ui.WcmXSLModule
                      extended bycom.filenet.wcm.apps.server.ui.WorkflowExpressionModule
All Implemented Interfaces:
com.filenet.wcm.toolkit.server.base.WcmModuleInterface, com.filenet.wcm.toolkit.server.base.WcmPanelInterface, com.filenet.wcm.toolkit.server.base.WcmPanelValidationInterface, com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface

public class WorkflowExpressionModule
extends com.filenet.wcm.toolkit.server.ui.WcmXSLModule
implements com.filenet.wcm.toolkit.server.base.WcmPanelInterface, com.filenet.wcm.toolkit.server.base.WcmPanelValidationInterface

The WorkflowExpressionModule class displays the either the workflow expression or the event filtering. It provides UI to create or modify expressions.


Field Summary
static java.lang.String EVENT_EXPRESSION_TYPE
           
static java.lang.String WORKFLOW_EXPRESSION_TYPE
           
 
Fields inherited from class com.filenet.wcm.toolkit.server.ui.WcmXSLModule
transformUtil
 
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
locale, NAME_DELIMITER
 
Constructor Summary
WorkflowExpressionModule(java.lang.String type)
          Constructor sets the WorkflowExpressionModule type to one of the static String values defined by the WorkflowExpressionModule module.
 
Method Summary
 void cleanup()
          Cleans up all cached data.
 java.lang.String getFormName()
          Returns the form name used by WorkflowExpressionSelect page.
 java.util.Iterator getValidationErrors()
          Implements the panelFinish method.
 void initialize()
          Initializes data providers, XSL parameters, and other state values.
 void onAdd(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Handles the Add event triggered by the user selecting the Add button to add a new criteria to the expression.
 void onAddUser(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Handles the AddUser event triggered by the user selecting a user from the Select Grantee page.
 void onAnd(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Handles the And event triggered by the user selecting the And button to add or insert an AND operator to the expression.
 void onLeft(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Handles the Left event triggered by the user selecting the ( button to add or insert a left parenthesis to the expression.
 void onMoveDown(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Handles the MoveDown event triggered by the user selecting the down arrow button to move all selected items down in the expression.
 void onMoveUp(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Handles the MoveUp event triggered by the user selecting the up arrow button to move all selected items up in the expression.
 void onNot(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Handles the Not event triggered by the user selecting the ! button to add or insert a not (!) operator to the expression.
 void onOr(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Handles the Or event triggered by the user selecting the Or button to add or insert an OR operator to the expression.
 void onRemove(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Handles the Remove event triggered by the user selecting the Remove button to remove all selected items from the expression.
 void onRight(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Handles the Right event triggered by the user selecting the ) button to add or insert a right parenthesis to the expression.
 void onSelectProperty(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Handles the SelectProperty event triggered by the user selecting an item from the property combo box.
 void onSelectUser(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Handles the SelectUser event triggered by the user selecting the Select User link.
 void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Handles the Start Page event triggered by the controller.
 void onViewException(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Handles the ViewException event triggered by the user selecting the Warning icon.
 void panelFinish(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Implements the panelFinish method.
 void panelSave(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Handles the panelSave event.
 boolean panelValidate()
          Validates the expressions to determine if it is valid.
 void render(java.io.Writer w)
          Renders the WorkflowExpressionModule Module HTML.
 
Methods inherited from class com.filenet.wcm.toolkit.server.ui.WcmXSLModule
convertToNodeList, getXML, getXSLParameter, renderXSL, setXML, setXML, setXML, setXML, setXSL, setXSLParameter, setXSLParameter, setXSLParameter, setXSLParameter, setXSLParameter, setXSLParameter
 
Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmUiModule
getActive, getBasePath, getBaseUrl, getBaseURLBuilder, getControllerEventUrl, getControllerEventUrl, getEventFormFields, getEventFormFields, getEventFormTag, getEventFormTag, getEventUrl, getEventUrl, getEventUrl, getEventUrl, getFormSubmitUrl, getFormSubmitUrl, getGlobalEventUrl, getGlobalEventUrl, getPageUrl, getPageUrl, getPageUrl, getPageUrl, getUiParent, peekEvent, renderJSP, routeEvent, routeEvent, serverSideInclude, serverSideInclude, setActive, setJSP
 
Methods inherited from class com.filenet.wcm.toolkit.server.base.GlobalEventModule
subscribeGlobalEvent
 
Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
addChild, addChild, addChild, debugTrace, getClassProperty, getClassProperty, getClassPropertyKeys, getConfiguration, getController, getDataStore, getModuleProperty, getModuleProperty, getModuleProperty, getModuleProperty, getModulePropertyKeys, getName, getParent, getWindowProperty, getWindowProperty, persist, queryDataProvider, setClassProperty, setClassProperty, setController, setModuleProperty, setModuleProperty, setName, setParent, setPortletParent, setWindowProperty
 
Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmDpContainer
addDataProvider, addDataProvider
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface
addDataProvider, getDataStore, getModuleProperty, getName, getParent, persist, queryDataProvider, setController, setModuleProperty, setName, setParent
 

Field Detail

WORKFLOW_EXPRESSION_TYPE

public static final java.lang.String WORKFLOW_EXPRESSION_TYPE
See Also:
Constant Field Values

EVENT_EXPRESSION_TYPE

public static final java.lang.String EVENT_EXPRESSION_TYPE
See Also:
Constant Field Values
Constructor Detail

WorkflowExpressionModule

public WorkflowExpressionModule(java.lang.String type)
Constructor sets the WorkflowExpressionModule type to one of the static String values defined by the WorkflowExpressionModule module.

Parameters:
type - String specifying the workflow expression type.
Method Detail

initialize

public void initialize()
                throws java.lang.Exception
Initializes data providers, XSL parameters, and other state values.

Specified by:
initialize in interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface
Throws:
java.lang.Exception - All errors.

onStartPage

public void onStartPage(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Handles the Start Page event triggered by the controller.

The module xsl xml and parameters are set.

Specified by:
onStartPage in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Parameters:
request - The JSP request object.
response - The JSP response object.
Throws:
java.lang.Exception - All errors.

onAdd

public void onAdd(javax.servlet.http.HttpServletRequest request,
                  javax.servlet.http.HttpServletResponse response)
           throws java.lang.Exception
Handles the Add event triggered by the user selecting the Add button to add a new criteria to the expression.

Parameters:
request - The JSP request object.
response - The JSP response object.
Throws:
java.lang.Exception - All errors.

onAnd

public void onAnd(javax.servlet.http.HttpServletRequest request,
                  javax.servlet.http.HttpServletResponse response)
           throws java.lang.Exception
Handles the And event triggered by the user selecting the And button to add or insert an AND operator to the expression.

Parameters:
request - The JSP request object.
response - The JSP response object.
Throws:
java.lang.Exception - All errors.

onOr

public void onOr(javax.servlet.http.HttpServletRequest request,
                 javax.servlet.http.HttpServletResponse response)
          throws java.lang.Exception
Handles the Or event triggered by the user selecting the Or button to add or insert an OR operator to the expression.

Parameters:
request - The JSP request object.
response - The JSP response object.
Throws:
java.lang.Exception - All errors.

onNot

public void onNot(javax.servlet.http.HttpServletRequest request,
                  javax.servlet.http.HttpServletResponse response)
           throws java.lang.Exception
Handles the Not event triggered by the user selecting the ! button to add or insert a not (!) operator to the expression.

Parameters:
request - The JSP request object.
response - The JSP response object.
Throws:
java.lang.Exception - All errors.

onRight

public void onRight(javax.servlet.http.HttpServletRequest request,
                    javax.servlet.http.HttpServletResponse response)
             throws java.lang.Exception
Handles the Right event triggered by the user selecting the ) button to add or insert a right parenthesis to the expression.

Parameters:
request - The JSP request object.
response - The JSP response object.
Throws:
java.lang.Exception - All errors.

onLeft

public void onLeft(javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response)
            throws java.lang.Exception
Handles the Left event triggered by the user selecting the ( button to add or insert a left parenthesis to the expression.

Parameters:
request - The JSP request object.
response - The JSP response object.
Throws:
java.lang.Exception - All errors.

onRemove

public void onRemove(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws java.lang.Exception
Handles the Remove event triggered by the user selecting the Remove button to remove all selected items from the expression.

Parameters:
request - The JSP request object.
response - The JSP response object.
Throws:
java.lang.Exception - All errors.

onMoveUp

public void onMoveUp(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws java.lang.Exception
Handles the MoveUp event triggered by the user selecting the up arrow button to move all selected items up in the expression.

Parameters:
request - The JSP request object.
response - The JSP response object.
Throws:
java.lang.Exception - All errors.

onMoveDown

public void onMoveDown(javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response)
                throws java.lang.Exception
Handles the MoveDown event triggered by the user selecting the down arrow button to move all selected items down in the expression.

Parameters:
request - The JSP request object.
response - The JSP response object.
Throws:
java.lang.Exception - All errors.

onSelectProperty

public void onSelectProperty(javax.servlet.http.HttpServletRequest request,
                             javax.servlet.http.HttpServletResponse response)
                      throws java.lang.Exception
Handles the SelectProperty event triggered by the user selecting an item from the property combo box.

Parameters:
request - The JSP request object.
response - The JSP response object.
Throws:
java.lang.Exception - All errors.

onSelectUser

public void onSelectUser(javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response)
                  throws java.lang.Exception
Handles the SelectUser event triggered by the user selecting the Select User link.

Parameters:
request - The JSP request object.
response - The JSP response object.
Throws:
java.lang.Exception - All errors.

onAddUser

public void onAddUser(javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response)
               throws java.lang.Exception
Handles the AddUser event triggered by the user selecting a user from the Select Grantee page. The user is saved in the module property and can be added to the expression by clicking on the add button.

Parameters:
request - The JSP request object.
response - The JSP response object.
Throws:
java.lang.Exception - All errors.

onViewException

public void onViewException(javax.servlet.http.HttpServletRequest request,
                            javax.servlet.http.HttpServletResponse response)
                     throws java.lang.Exception
Handles the ViewException event triggered by the user selecting the Warning icon. expression.

Parameters:
request - The JSP request object.
response - The JSP response object.
Throws:
java.lang.Exception - All errors.

render

public void render(java.io.Writer w)
            throws java.lang.Exception
Renders the WorkflowExpressionModule Module HTML.

Specified by:
render in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Parameters:
w - Writer object to write the output to.
Throws:
java.lang.Exception - All errors.

panelSave

public void panelSave(javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response)
               throws java.lang.Exception
Handles the panelSave event.

Any changes to the workflow expression or the event expression are saved back the the subscription XML.

Specified by:
panelSave in interface com.filenet.wcm.toolkit.server.base.WcmPanelInterface
Parameters:
request - The JSP request object.
response - The JSP response object.
Throws:
java.lang.Exception - All errors.

panelFinish

public void panelFinish(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Implements the panelFinish method. It is not used.

Specified by:
panelFinish in interface com.filenet.wcm.toolkit.server.base.WcmPanelInterface
Throws:
java.lang.Exception

cleanup

public void cleanup()
             throws java.lang.Exception
Cleans up all cached data.

Specified by:
cleanup in interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface
Throws:
java.lang.Exception - All errors.

getFormName

public java.lang.String getFormName()
Returns the form name used by WorkflowExpressionSelect page.

Specified by:
getFormName in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Returns:
The form name, returns null if no form is used.

panelValidate

public boolean panelValidate()
                      throws java.lang.Exception
Validates the expressions to determine if it is valid.

Specified by:
panelValidate in interface com.filenet.wcm.toolkit.server.base.WcmPanelValidationInterface
Returns:
boolean true if it is valid.
Throws:
java.lang.Exception - All Exception

getValidationErrors

public java.util.Iterator getValidationErrors()
Implements the panelFinish method. It is not used.

Specified by:
getValidationErrors in interface com.filenet.wcm.toolkit.server.base.WcmPanelValidationInterface
Returns:
null;


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