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

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
All Implemented Interfaces:
com.filenet.wcm.toolkit.server.base.WcmModuleInterface, com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Direct Known Subclasses:
ParticipantSelect, WcmGroupSelect, WcmStepReassignOperation

public class GranteeSelect
extends WcmWorkplaceLayoutModule

Provides ui to find users or groups.


Field Summary
protected static int CONTAINS
           
protected  com.filenet.wcm.toolkit.server.base.WcmController controller
           
protected  java.lang.String domainName
           
protected static int ENDS_WITH
           
protected  java.lang.String granteeType
           
static int GROUP_MODE
           
protected  int maxResults
           
static int MULTI_SELECTION_MODE
           
static java.lang.String PARAM_EXCLUDE_AUTHENTICATED_USERS
           
static java.lang.String PARAM_EXCLUDE_CREATOR_OWNER
           
static java.lang.String PARAM_INIT_GROUPS_WITH_AUTHENTICATED_USERS
           
static java.lang.String PARAM_SEARCH_MODE
           
static java.lang.String PARAM_SELECT_URL
           
static java.lang.String PARAM_SELECTION_MODE
           
static java.lang.String PARAM_TITLE
           
static java.lang.String PARAM_TITLE_TYPE
           
protected  com.filenet.wcm.apps.server.presentation.ui.PathView pathView
           
protected  boolean patternNotSpecified
           
protected  org.w3c.dom.Document realmXML
           
protected  java.lang.String returnURL
           
protected  com.filenet.wcm.toolkit.server.base.WcmUiModule searchModule
           
protected  java.lang.String searchPattern
           
protected  org.w3c.dom.Document searchResult
           
protected  java.lang.String searchType
           
protected  java.lang.String searchURL
           
protected  com.filenet.wcm.toolkit.server.base.WcmUiModule selectModule
           
protected  java.lang.String selectURL
           
static int SINGLE_SELECTION_MODE
           
protected static int STARTS_WITH
           
protected  WcmTextLinksBar textLinksBarModule
           
static java.lang.String TITLE_TYPE_PRIMARY
           
static java.lang.String TITLE_TYPE_SECONDARY
           
static int USER_GROUP_MODE
           
static int USER_MODE
           
protected  com.filenet.wcm.toolkit.util.WcmString wsStatus
           
protected  com.filenet.wcm.toolkit.util.WcmString 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
GranteeSelect()
           
 
Method Summary
protected  void addCommandButton()
          Adds the Continue button to exit the page.
protected  void addExitButton()
          Adds the Exit button to exit the page.
protected  void addSearchModule()
          Adds a search ui module.
protected  void addSelectModule()
          Adds a select ui module.
 void cleanup()
          Handles the controller cleanup call.
protected  int getDefaultType()
          Returns the default grantee type for the selected search mode.
protected  java.lang.String getDomainId()
          Returns the authenticated default domain id.
protected  java.lang.String getDomainName()
          Returns the authenticated default domain name.
 java.lang.String getFormName()
          Returns the form name used by the GranteeSelect UI.
protected  org.w3c.dom.NodeList getGrantees()
           
protected  int getMaxResult()
          Returns the maximum number of item that will be displayed.
protected  org.w3c.dom.Document getRealmList()
          Returns the realm XML.
 int getSearchMode()
          Returns the Select Grantees search mode.
 int getSelectionMode()
          Returns the Select Grantees selection mode.
 void initialize()
          Initializes the class data.
 void onAccept(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Saves selections and returns the previous page.
 void onCancel(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Returns to the calling page.
 void onClose(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Returns to the calling page after closing the window.
 void onContinue(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Saves selections and returns the previous page.
 void onExit(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Returns to the calling page after closing the window.
 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)
          Event handler for controllers onStartPage event.
 void onSubmit(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Submit the form.
protected  void renderLayout(java.io.Writer w)
          Renders the layout.
 void setExcludeAuthenticatedUsers(boolean yes)
          Sets this to true to exclude the #AUTHENTICATED_USERS group from the search result.
 void setExcludeCreatorOwner(boolean yes)
          Sets this to true to exclude the #CREATOR_OWNER user from the search result.
 void setHideDomainName(boolean yes)
          Sets this to true to hide the domain name.
 void setOperationTitle(com.filenet.wcm.toolkit.util.WcmString title)
          Set the selection page title.
 void setOperationTitle(com.filenet.wcm.toolkit.util.WcmString title, boolean primaryTitle)
          Set the selection page title.
 void setPath(java.lang.String pathItemLabel, com.filenet.wcm.toolkit.util.WcmString pathTitle)
          Configures contained WcmPathView module to have one non-clickable anchor with the specified label.
 void setSearchMode(int mode)
          Sets the Select Grantees search mode.
 void setSelectionMode(int mode)
          Sets the Select Grantees selection mode.
 
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
 

Field Detail

wsStatus

protected com.filenet.wcm.toolkit.util.WcmString wsStatus

wsWarning

protected com.filenet.wcm.toolkit.util.WcmString wsWarning

STARTS_WITH

protected static final int STARTS_WITH
See Also:
Constant Field Values

ENDS_WITH

protected static final int ENDS_WITH
See Also:
Constant Field Values

CONTAINS

protected static final int CONTAINS
See Also:
Constant Field Values

patternNotSpecified

protected boolean patternNotSpecified

PARAM_TITLE

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

PARAM_TITLE_TYPE

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

PARAM_EXCLUDE_CREATOR_OWNER

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

PARAM_EXCLUDE_AUTHENTICATED_USERS

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

PARAM_SEARCH_MODE

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

PARAM_SELECTION_MODE

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

PARAM_SELECT_URL

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

PARAM_INIT_GROUPS_WITH_AUTHENTICATED_USERS

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

USER_MODE

public static final int USER_MODE
See Also:
Constant Field Values

GROUP_MODE

public static final int GROUP_MODE
See Also:
Constant Field Values

USER_GROUP_MODE

public static final int USER_GROUP_MODE
See Also:
Constant Field Values

SINGLE_SELECTION_MODE

public static final int SINGLE_SELECTION_MODE
See Also:
Constant Field Values

MULTI_SELECTION_MODE

public static final int MULTI_SELECTION_MODE
See Also:
Constant Field Values

TITLE_TYPE_PRIMARY

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

TITLE_TYPE_SECONDARY

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

controller

protected com.filenet.wcm.toolkit.server.base.WcmController controller

textLinksBarModule

protected WcmTextLinksBar textLinksBarModule

pathView

protected com.filenet.wcm.apps.server.presentation.ui.PathView pathView

searchModule

protected com.filenet.wcm.toolkit.server.base.WcmUiModule searchModule

selectModule

protected com.filenet.wcm.toolkit.server.base.WcmUiModule selectModule

domainName

protected java.lang.String domainName

granteeType

protected java.lang.String granteeType

searchType

protected java.lang.String searchType

searchPattern

protected java.lang.String searchPattern

searchResult

protected org.w3c.dom.Document searchResult

maxResults

protected int maxResults

returnURL

protected java.lang.String returnURL

searchURL

protected java.lang.String searchURL

selectURL

protected java.lang.String selectURL

realmXML

protected org.w3c.dom.Document realmXML
Constructor Detail

GranteeSelect

public GranteeSelect()
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 WcmWorkplaceLayoutModule
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
Event handler for controllers onStartPage event.

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

renderLayout

protected void renderLayout(java.io.Writer w)
                     throws java.lang.Exception
Renders the layout.

Overrides:
renderLayout in class WcmWorkplaceLayoutModule
Parameters:
w - Writer for writing to the response object.
Throws:
java.lang.Exception - If there are problems.

onSearch

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

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

onSubmit

public void onSubmit(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws java.lang.Exception
Submit the form.

Parameters:
request - The JSP request object HttpServletRequest
response - The JSP response object HttpServletResponse
Throws:
java.lang.Exception - If there are problems retrieving data.

cleanup

public void cleanup()
             throws java.lang.Exception
Handles the controller cleanup call.

Throws:
java.lang.Exception

getRealmList

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

Returns:
Document XLM holding the available realm list.
Throws:
java.lang.Exception - All errors.

getMaxResult

protected int getMaxResult()
                    throws java.lang.Exception
Returns the maximum number of item that will be displayed.

Returns:
int The maximum number of item that will be displayed.
Throws:
java.lang.Exception

getDomainId

protected java.lang.String getDomainId()
                                throws java.lang.Exception
Returns the authenticated default domain id.

Returns:
String The default domain id.
Throws:
java.lang.Exception

getDomainName

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

Returns:
String The default domain name.
Throws:
java.lang.Exception

getDefaultType

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

Returns:
String The default domain name.

onAccept

public void onAccept(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws java.lang.Exception
Saves selections and returns the previous page.

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 selections and returns the previous page.

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
Returns to the calling page after closing the window.

Parameters:
request - HttpServletRequest is the JSP request object.
response - HttpServletResponse is the JSP response object.
Throws:
java.lang.Exception - If there are problems retrieving data.

onExit

public void onExit(javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response)
            throws java.lang.Exception
Returns to the calling page after closing the window.

Parameters:
request - HttpServletRequest is the JSP request object.
response - HttpServletResponse is the JSP response object.
Throws:
java.lang.Exception - If there are problems retrieving data.

onCancel

public void onCancel(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws java.lang.Exception
Returns to the calling page.

Parameters:
request - HttpServletRequest is the JSP request object.
response - HttpServletResponse is the JSP response object.
Throws:
java.lang.Exception - If there are problems retrieving data.

getFormName

public java.lang.String getFormName()
Returns the form name used by the GranteeSelect UI.

Returns:
String The html form name.

setHideDomainName

public void setHideDomainName(boolean yes)
Sets this to true to hide the domain name.

Parameters:
yes - boolean true to not show the domain name.

setExcludeCreatorOwner

public void setExcludeCreatorOwner(boolean yes)
Sets this to true to exclude the #CREATOR_OWNER user from the search result.

Parameters:
yes - boolean true to exclcude exclude the #CREATOR_OWNER user from the search result.

setExcludeAuthenticatedUsers

public void setExcludeAuthenticatedUsers(boolean yes)
Sets this to true to exclude the #AUTHENTICATED_USERS group from the search result.

Parameters:
yes - boolean true to exclcude exclude the #AUTHENTICATED_USERS group from the search result

setPath

public void setPath(java.lang.String pathItemLabel,
                    com.filenet.wcm.toolkit.util.WcmString pathTitle)
Configures contained WcmPathView module to have one non-clickable anchor with the specified label.

Parameters:
pathItemLabel - String label displayed in the WcmPathView module
pathTitle - WcmString Title displayed in the WcmPathView module

setSearchMode

public void setSearchMode(int mode)
Sets the Select Grantees search mode.

Parameters:
mode - int the search mode (USER_MODE, GROUP_MODE or USER_GROUP_MODE).

getSearchMode

public int getSearchMode()
Returns the Select Grantees search mode. In a USER_GROUP_MODE, the user can either search for groups or users.

Returns:
int the search mode (USER_MODE, GROUP_MODE or USER_GROUP_MODE).

setSelectionMode

public void setSelectionMode(int mode)
Sets the Select Grantees selection mode.

Parameters:
mode - int the selection mode (SINGLE_SELECTION_MODE or MULTI_SELECTION_MODE).

getSelectionMode

public int getSelectionMode()
Returns the Select Grantees selection mode.

Returns:
int the selection mode (SINGLE_SELECTION_MODE or MULTI_SELECTION_MODE).

setOperationTitle

public void setOperationTitle(com.filenet.wcm.toolkit.util.WcmString title)
                       throws java.lang.Exception
Set the selection page title. By default, it is a secondary title.

Overrides:
setOperationTitle in class WcmWorkplaceLayoutModule
Parameters:
title - The title of the page.
Throws:
java.lang.Exception

setOperationTitle

public void setOperationTitle(com.filenet.wcm.toolkit.util.WcmString title,
                              boolean primaryTitle)
                       throws java.lang.Exception
Set the selection page title.

Overrides:
setOperationTitle in class WcmWorkplaceLayoutModule
Parameters:
title - The title of the page.
primaryTitle - true for main title and false for secondary title (i.e.: main title - secondary title)
Throws:
java.lang.Exception

addSearchModule

protected void addSearchModule()
                        throws java.lang.Exception
Adds a search ui module. This can be overrided to provide a different search module that provides a different UI for searching.

Throws:
java.lang.Exception - All Exceptions

addSelectModule

protected void addSelectModule()
                        throws java.lang.Exception
Adds a select ui module. This can be overrided to provide a different select module that provides a different UI for selection the result.

Throws:
java.lang.Exception - All Exceptions

addExitButton

protected void addExitButton()
                      throws java.lang.Exception
Adds the Exit button to exit the page. This can be overrided to provide a different Exit button.

Throws:
java.lang.Exception - All exceptions

addCommandButton

protected void addCommandButton()
                         throws java.lang.Exception
Adds the Continue button to exit the page. This can be overrided to provide a different Continue button.

Throws:
java.lang.Exception - All exceptions

getGrantees

protected org.w3c.dom.NodeList getGrantees()
                                    throws java.lang.Exception
Throws:
java.lang.Exception


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