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

Class SubscribedEventSelect

java.lang.Object
com.filenet.wcm.toolkit.server.base.WcmDpContainer
com.filenet.wcm.toolkit.server.base.WcmModule
com.filenet.wcm.toolkit.server.base.GlobalEventModule
com.filenet.wcm.toolkit.server.base.WcmUiModule
com.filenet.wcm.toolkit.server.ui.WcmJSPModule
com.filenet.wcm.toolkit.server.ui.WcmLayoutModule
com.filenet.wcm.apps.server.ui.layout.WcmWorkplaceLayoutModule
com.filenet.wcm.apps.server.ui.select.SubscribedEventSelect

All implemented interfaces:

com.filenet.wcm.toolkit.server.base.WcmModuleInterface, com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface

public class SubscribedEventSelect
extends WcmWorkplaceLayoutModule

Displays the Subscribed Events selection module. This module displays a list of subscribed events to choose from.

Field Summary

Modifier and Type	Field and Description
static int	`CUSTOM_OBJECT_EVENT_TYPE`
static java.lang.String[]	`customObjectExcludedEventIds`
static int	`DOCUMENT_EVENT_TYPE`
static java.lang.String[]	`documentExcludedEventIds`
static int	`FOLDER_EVENT_TYPE`
static java.lang.String[]	`folderExcludedEventIds`

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

Constructor and Description
`SubscribedEventSelect()` Constructor

Method Summary

Modifier and Type	Method and Description
java.lang.String	`getFormName()` Returns the form name.
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 event to the selected event list.
void	`onAddAll(javax.servlet.http.HttpServletRequest request,javax.servlet.http.HttpServletResponse response)` Adds all available events to selected event list.
void	`onClose(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 events from the selected event list.
void	`onRemoveAll(javax.servlet.http.HttpServletRequest request,javax.servlet.http.HttpServletResponse response)` Adds all available evennts to selected event list.
void	`onStartPage(javax.servlet.http.HttpServletRequest request,javax.servlet.http.HttpServletResponse response)` Initialize data and xsl data.
protected void	`renderLayout(java.io.Writer w)` Renders the layout.

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, setOperationTitle, setOperationTitle, setRemoveTreeModule, setShowFooterLinksBar, setTabBarSelection`

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, 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

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`

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

Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
`addChild, addChild, addChild, cleanup, 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`

addChild, addChild, addChild, cleanup, 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, cleanup, getDataStore, getModuleProperty, getName, getParent, persist, queryDataProvider, setController, setModuleProperty, setName, setParent`

Field Detail

DOCUMENT_EVENT_TYPE

public static final int DOCUMENT_EVENT_TYPE

FOLDER_EVENT_TYPE

public static final int FOLDER_EVENT_TYPE

CUSTOM_OBJECT_EVENT_TYPE

public static final int CUSTOM_OBJECT_EVENT_TYPE

documentExcludedEventIds

public static final java.lang.String[] documentExcludedEventIds

folderExcludedEventIds

public static final java.lang.String[] folderExcludedEventIds

customObjectExcludedEventIds

public static final java.lang.String[] customObjectExcludedEventIds

Constructor Detail

SubscribedEventSelect

public SubscribedEventSelect()
throws java.lang.Exception

Constructor

Throws:

java.lang.Exception - and exception object

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

Initialize data and xsl data.

Specified by:

onStartPage in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface

Overrides:

onStartPage in class com.filenet.wcm.toolkit.server.base.GlobalEventModule

Parameters:

request - The JSP request object HttpServletRequest

response - The JSP response object HttpServletResponse

Throws:

java.lang.Exception - If there are problems retrieving data.

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 com.filenet.wcm.toolkit.server.base.WcmUiModule

Returns:

form name

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.

onAccept

public void onAccept(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
throws java.lang.Exception

Saves changes to XML document.

Parameters:

request - The JSP request object HttpServletRequest

response - The JSP response object HttpServletResponse

Throws:

java.lang.Exception - and Exception object if something goes wrong

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.

Parameters:

request - The JSP request object HttpServletRequest

response - The JSP response object HttpServletResponse

Throws:

java.lang.Exception - an Exception object if something goes wrong

onAddAll

public void onAddAll(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
throws java.lang.Exception

Adds all available events to selected event list.

Parameters:

request - The JSP request object HttpServletRequest

response - The JSP response object HttpServletResponse

Throws:

java.lang.Exception - an Exception object if something goes wrong

onAdd

public void onAdd(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
throws java.lang.Exception

Adds the selected event to the selected event list.

Parameters:

request - The JSP request object HttpServletRequest

response - The JSP response object HttpServletResponse

Throws:

java.lang.Exception - an Exception object if something goes wrong

onRemoveAll

public void onRemoveAll(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
throws java.lang.Exception

Adds all available evennts to selected event list.

Parameters:

request - The JSP request object HttpServletRequest

response - The JSP response object HttpServletResponse

Throws:

java.lang.Exception - an Exception object if something goes wrong

onRemove

public void onRemove(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
throws java.lang.Exception

Removes the selected events from the selected event list.

Parameters:

request - The JSP request object HttpServletRequest

response - The JSP response object HttpServletResponse

Throws:

java.lang.Exception - an Exception object if something goes wrong