com.filenet.wcm.apps.server.ui.select
Class WcmGroupSelect

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.WcmJSPModule
                      extended bycom.filenet.wcm.toolkit.server.ui.WcmLayoutModule
                          extended bycom.filenet.wcm.apps.server.ui.layout.WcmWorkplaceLayoutModule
                              extended bycom.filenet.wcm.apps.server.ui.select.GranteeSelect
                                  extended bycom.filenet.wcm.apps.server.ui.select.WcmGroupSelect
All Implemented Interfaces:
com.filenet.wcm.toolkit.server.base.WcmModuleInterface, com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface

public class WcmGroupSelect
extends GranteeSelect

Displays the Workflow Group selection module. This module displays a list of participants to choose from.


Field Summary
 
Fields inherited from class com.filenet.wcm.apps.server.ui.select.GranteeSelect
CONTAINS, controller, domainName, ENDS_WITH, granteeType, GROUP_MODE, maxResults, MULTI_SELECTION_MODE, PARAM_EXCLUDE_AUTHENTICATED_USERS, PARAM_EXCLUDE_CREATOR_OWNER, PARAM_INIT_GROUPS_WITH_AUTHENTICATED_USERS, PARAM_SEARCH_MODE, PARAM_SELECT_URL, PARAM_SELECTION_MODE, PARAM_TITLE, PARAM_TITLE_TYPE, pathView, patternNotSpecified, realmXML, returnURL, searchModule, searchPattern, searchResult, searchType, searchURL, selectModule, selectURL, SINGLE_SELECTION_MODE, STARTS_WITH, textLinksBarModule, TITLE_TYPE_PRIMARY, TITLE_TYPE_SECONDARY, USER_GROUP_MODE, USER_MODE, wsStatus, wsWarning
 
Fields inherited from class com.filenet.wcm.apps.server.ui.layout.WcmWorkplaceLayoutModule
bannerModule, contextMenu, footerLinksBarModule, footerModule, leftCSSClass, MAIN_MODE, multiSelectMenu, OPERATION_MODE, renderLeftBar, showFooterLinksBar, tabBarModule, treeModule
 
Fields inherited from class com.filenet.wcm.toolkit.server.ui.WcmLayoutModule
jspMode, layout
 
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
locale, NAME_DELIMITER
 
Constructor Summary
WcmGroupSelect()
          Constructor
 
Method Summary
protected  void addCommandButton()
          Overrides the SelectGrantees method to provide a different text for the Continue button.
protected  void addExitButton()
          Overrides the SelectGrantees method to provide a different text for the Exit button.
protected  void addSelectModule()
          Overrides the SelectGrantees method to provide a different selection module that supports a result and a selection combo list box.
protected  int getDefaultType()
          Overides the base class and returns the default grantee type for the selected search mode.
protected  java.lang.String getDomainName()
          Returns the default domain name.
 java.lang.String getFormName()
          Returns the form name.
protected  org.w3c.dom.Document getRealmList()
          Returns the realm XML.
 void initialize()
          Initializes the class data.
 void onAccept(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Saves changes to XML document.
 void onAdd(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Adds the selected users or groups to the participant list.
 void onAddAll(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Adds all available users or groups to selected participants.
 void onBannerClose(com.filenet.wcm.toolkit.server.util.event.GlobalEvent e)
          Handle Banner Close event
 void onClose(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Cancels any changes and return to the previous page.
 void onContinue(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Saves changes to XML document.
 void onExit(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Cancels any changes and return to the previous page.
 void onRemove(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Removes the selected participants from the participant list.
 void onSearch(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Handles the search event.
 void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Add the appropriate command Button to the toolbar.
 
Methods inherited from class com.filenet.wcm.apps.server.ui.select.GranteeSelect
addSearchModule, cleanup, getDomainId, getGrantees, getMaxResult, getSearchMode, getSelectionMode, onCancel, onSubmit, renderLayout, setExcludeAuthenticatedUsers, setExcludeCreatorOwner, setHideDomainName, setOperationTitle, setOperationTitle, setPath, setSearchMode, setSelectionMode
 
Methods inherited from class com.filenet.wcm.apps.server.ui.layout.WcmWorkplaceLayoutModule
addModule, addModule, addPrimaryPageAnchors, createLayout, getAnchorTree, getBannerBar, getFooter, getFooterLinksBar, getOperationTitle, getPageTabId, getPrimaryPageAnchors, getTabBar, isAdminLinkAvailable, registerAddedModules, resetPrimaryPageAnchors, setAddContextMenu, setMode, setOperationTitle, setOperationTitle, setRemoveTreeModule, setShowFooterLinksBar, setTabBarSelection
 
Methods inherited from class com.filenet.wcm.toolkit.server.ui.WcmLayoutModule
getLayout, render, setJSP
 
Methods inherited from class com.filenet.wcm.toolkit.server.ui.WcmJSPModule
getCurrentModule
 
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
 
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
 

Constructor Detail

WcmGroupSelect

public WcmGroupSelect()
               throws java.lang.Exception
Constructor

Throws:
java.lang.Exception
Method Detail

initialize

public void initialize()
                throws java.lang.Exception
Initializes the class data.

Specified by:
initialize in interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface
Overrides:
initialize in class GranteeSelect
Throws:
java.lang.Exception - If there are problems.

onStartPage

public void onStartPage(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Add the appropriate command Button to the toolbar.

Specified by:
onStartPage in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Overrides:
onStartPage in class GranteeSelect
Parameters:
request - The JSP request object HttpServletRequest
response - The JSP response object HttpServletResponse
Throws:
java.lang.Exception - If there are problems retrieving data.

getRealmList

protected org.w3c.dom.Document getRealmList()
                                     throws java.lang.Exception
Returns the realm XML.

Overrides:
getRealmList in class GranteeSelect
Returns:
Document XLM holding the available realm list.
Throws:
java.lang.Exception - All errors.

getDomainName

protected java.lang.String getDomainName()
                                  throws java.lang.Exception
Returns the default domain name.

Overrides:
getDomainName in class GranteeSelect
Returns:
String The default domain name.
Throws:
java.lang.Exception

getDefaultType

protected int getDefaultType()
Overides the base class and returns the default grantee type for the selected search mode. The grantee type determines the initial selection of the Users or Groups radio button.

Overrides:
getDefaultType in class GranteeSelect
Returns:
String The default domain name.

getFormName

public java.lang.String getFormName()
Returns the form name.

Specified by:
getFormName in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Overrides:
getFormName in class GranteeSelect
Returns:
form name

onSearch

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

Overrides:
onSearch in class GranteeSelect
Parameters:
request - The JSP request object HttpServletRequest
response - The JSP response object HttpServletResponse
Throws:
java.lang.Exception

onContinue

public void onContinue(javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response)
                throws java.lang.Exception
Saves changes to XML document.

Overrides:
onContinue in class GranteeSelect
Parameters:
request - The JSP request object HttpServletRequest
response - The JSP response object HttpServletResponse
Throws:
java.lang.Exception

onAccept

public void onAccept(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws java.lang.Exception
Saves changes to XML document.

Overrides:
onAccept in class GranteeSelect
Parameters:
request - The JSP request object HttpServletRequest
response - The JSP response object HttpServletResponse
Throws:
java.lang.Exception

onExit

public void onExit(javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response)
            throws java.lang.Exception
Cancels any changes and return to the previous page.

Overrides:
onExit in class GranteeSelect
Parameters:
request - The JSP request object HttpServletRequest
response - The JSP response object HttpServletResponse
Throws:
java.lang.Exception

onClose

public void onClose(javax.servlet.http.HttpServletRequest request,
                    javax.servlet.http.HttpServletResponse response)
             throws java.lang.Exception
Cancels any changes and return to the previous page.

Overrides:
onClose in class GranteeSelect
Parameters:
request - The JSP request object HttpServletRequest
response - The JSP response object HttpServletResponse
Throws:
java.lang.Exception

onBannerClose

public void onBannerClose(com.filenet.wcm.toolkit.server.util.event.GlobalEvent e)
                   throws java.lang.Exception
Handle Banner Close event

Parameters:
e - GlobalEvent
Throws:
java.lang.Exception

onAddAll

public void onAddAll(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws java.lang.Exception
Adds all available users or groups to selected participants.

Parameters:
request - The JSP request object HttpServletRequest
response - The JSP response object HttpServletResponse
Throws:
java.lang.Exception

onAdd

public void onAdd(javax.servlet.http.HttpServletRequest request,
                  javax.servlet.http.HttpServletResponse response)
           throws java.lang.Exception
Adds the selected users or groups to the participant list.

Parameters:
request - The JSP request object HttpServletRequest
response - The JSP response object HttpServletResponse
Throws:
java.lang.Exception

onRemove

public void onRemove(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws java.lang.Exception
Removes the selected participants from the participant list.

Parameters:
request - The JSP request object HttpServletRequest
response - The JSP response object HttpServletResponse
Throws:
java.lang.Exception

addSelectModule

protected void addSelectModule()
                        throws java.lang.Exception
Overrides the SelectGrantees method to provide a different selection module that supports a result and a selection combo list box.

Overrides:
addSelectModule in class GranteeSelect
Throws:
java.lang.Exception

addExitButton

protected void addExitButton()
                      throws java.lang.Exception
Overrides the SelectGrantees method to provide a different text for the Exit button.

Overrides:
addExitButton in class GranteeSelect
Throws:
java.lang.Exception

addCommandButton

protected void addCommandButton()
                         throws java.lang.Exception
Overrides the SelectGrantees method to provide a different text for the Continue button.

Overrides:
addCommandButton in class GranteeSelect
Throws:
java.lang.Exception


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