com.filenet.wcm.apps.server.ui.info.processors
Class TaskInfoPage

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.apps.server.ui.info.processors.TaskInfoPage
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, com.filenet.wcm.toolkit.server.base.WcmViewPanelInterface
Direct Known Subclasses:
WcmWorkflowInfoPage

public class TaskInfoPage
extends com.filenet.wcm.toolkit.server.base.WcmUiModule
implements com.filenet.wcm.toolkit.server.base.WcmViewPanelInterface, com.filenet.wcm.toolkit.server.base.WcmPanelValidationInterface


Field Summary
protected  com.filenet.wcm.toolkit.server.dp.WcmAuthoringDataProvider adp
           
protected  com.filenet.wcm.toolkit.server.dp.WcmEProcessDataProvider edp
           
protected  EProcessMultilingualUtil eProcessMultilingualUtil
           
protected  com.filenet.wcm.toolkit.server.util.WcmEProcessUtil eProcessUtil
           
protected static java.lang.String formName
           
protected static java.lang.String name
           
protected  int processorType
           
protected  com.filenet.wcm.toolkit.server.util.WcmStepElementState stepElementState
           
protected  TaskAttachmentsListView taskAttachments
           
protected  TaskFooterModule taskFooter
           
protected  TaskHeaderModule taskHeader
           
protected  TaskParameterModule taskParameter
           
protected  org.w3c.dom.Document xmlDoc
           
 
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
locale, NAME_DELIMITER
 
Constructor Summary
TaskInfoPage(int processorType)
          Constructor
 
Method Summary
 void addAttachment(java.lang.String attachmentName, java.lang.String objectStoreName, java.lang.String objectId, java.lang.String verSerId, java.lang.String objectType)
          Add or assign the selected attachment (document, folder, or search) to the current attachments list.
 void addReferenceAttachment(java.lang.String attachmentName, java.lang.String type, java.lang.String path)
          Add or assign the selected attachment (document, folder, or search) to the current attachments list.
 java.lang.String buildSelectFileURL()
          Return the required Url string for the Select Object page.
 java.lang.String buildSelectObjectURL()
          Return the required Url string for the Select Object page.
 void cleanup()
          Cleans up.
protected  java.lang.String getExecuteKey()
          Accessor method for getting the Executed Add key.
 java.lang.String getFormName()
          Returns the form name.
 java.util.Iterator getValidationErrors()
           
 void initialize()
          Initializes the class data.
 boolean isApplyButtonRequired()
          Implement, and return "true" if you want the WcmInfo container to show an "Apply" button.
 boolean isAttachmentsModified()
          Return true if the Attachments state has changed as a result of a panelSave call.
 boolean isModified()
          Return true if the Fields or Groups state has changed as a result of a panelSave call.
 void onAddFormTemplate(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Show the Form Template Page to allow the user to add a new object using the template and then add the newly added object to the end of the array.
 void onAddTemplate(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Show the Entry Template Wizard to allow the user to add a new object using the template and then add the newly added object to the end of the array.
 void onAssign(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Show the select object pages to allow the user to navigate (or search) for an object to assign to the current array index.
 void onAssignReference(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Show the select file page to allow the user to select an URL or UNC type of attachment for the current index.
 void onGetInfo(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Open the object information page in a popup window
 void onGroupModified(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Event handler used by multi-value selection pages to call back and refresh list
 void onRemove(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Remove the select item from the attachment items list completely.
 void onReplaceFormTemplate(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Show the Form Template page to allow the user to add a new object using the template and then replace the Form Template attachment item with the newly added Form Data.
 void onReplaceTemplate(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Show the Entry Template Wizard to allow the user to add a new object using the template and then replace the Entry Template attachment item with the newly added object.
 void onSelectAttachment(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Used attachment links to expand/collapse the attachment items.
 void onSelectField(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Used by links to redirect to secondary field selection pages after it submits the form by calling onSubmit.
 void onSelectFile(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Handle the select file event.
 void onSelectGroup(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Used by links to redirect to secondary workflow group selection pages after it submits the form by calling onSubmit.
 void onSelectObject(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Handle the select object event.
 void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Adds the appropriate command button to the toolbar.
 void onSubmit(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Saves the data field changes to the data provider.
 void onUnassign(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Remove the select item from the attachment items list and specify location as unassigned.
 void panelFinish(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Signals the UI module to commit its state to the data provider.
 void panelSave(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Signals the UI module to persist the incoming form data to its current state.
 boolean panelValidate()
          Called on a page to check any entered data to confirm that everything is valid.
 void removeAttachment(java.lang.String attachmentName, java.lang.String objectStoreName, java.lang.String objectId, java.lang.String verSerId, java.lang.String objectType, java.lang.String position, boolean unassign)
          Remove or unassign the selected attachment from the current attachments list.
 void render(java.io.Writer w)
          Renders the class data.
 void setIsAttachmentModified(boolean modified)
          Set the modified state.
 void setIsModified(boolean modified)
          Set the modified state.
 void setLocale(java.util.Locale locale)
          Set the locale
 void setPageInfo(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Set the cached page data into the step element object.
 
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

name

protected static final java.lang.String name
See Also:
Constant Field Values

formName

protected static final java.lang.String formName
See Also:
Constant Field Values

edp

protected com.filenet.wcm.toolkit.server.dp.WcmEProcessDataProvider edp

adp

protected com.filenet.wcm.toolkit.server.dp.WcmAuthoringDataProvider adp

stepElementState

protected com.filenet.wcm.toolkit.server.util.WcmStepElementState stepElementState

eProcessUtil

protected com.filenet.wcm.toolkit.server.util.WcmEProcessUtil eProcessUtil

eProcessMultilingualUtil

protected EProcessMultilingualUtil eProcessMultilingualUtil

taskHeader

protected TaskHeaderModule taskHeader

taskAttachments

protected TaskAttachmentsListView taskAttachments

taskParameter

protected TaskParameterModule taskParameter

taskFooter

protected TaskFooterModule taskFooter

processorType

protected int processorType

xmlDoc

protected org.w3c.dom.Document xmlDoc
Constructor Detail

TaskInfoPage

public TaskInfoPage(int processorType)
             throws java.lang.Exception
Constructor

Parameters:
processorType - Operation type (step processor or launch step processor)
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
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
Adds the appropriate command button to the toolbar.

Specified by:
onStartPage in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Parameters:
request - The Java™Server Pages (JSP) request object HttpServletRequest
response - The JSP response object HttpServletResponse
Throws:
java.lang.Exception - If there are problems retrieving data.

getExecuteKey

protected java.lang.String getExecuteKey()
Accessor method for getting the Executed Add key.

Returns:
String holding the author state key to use to get the value of the executed Add state

render

public void render(java.io.Writer w)
            throws java.lang.Exception
Renders the class data.

Specified by:
render in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Parameters:
w - Writer for writing to the response object.
Throws:
java.lang.Exception - If there are problems.

onSelectField

public void onSelectField(javax.servlet.http.HttpServletRequest request,
                          javax.servlet.http.HttpServletResponse response)
                   throws java.lang.Exception
Used by links to redirect to secondary field selection pages after it submits the form by calling onSubmit.

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

onSelectGroup

public void onSelectGroup(javax.servlet.http.HttpServletRequest request,
                          javax.servlet.http.HttpServletResponse response)
                   throws java.lang.Exception
Used by links to redirect to secondary workflow group selection pages after it submits the form by calling onSubmit.

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

onSelectAttachment

public void onSelectAttachment(javax.servlet.http.HttpServletRequest request,
                               javax.servlet.http.HttpServletResponse response)
                        throws java.lang.Exception
Used attachment links to expand/collapse the attachment items. It first submits the form by calling onSubmit.

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

onGroupModified

public void onGroupModified(javax.servlet.http.HttpServletRequest request,
                            javax.servlet.http.HttpServletResponse response)
                     throws java.lang.Exception
Event handler used by multi-value selection pages to call back and refresh list

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

onGetInfo

public void onGetInfo(javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response)
               throws java.lang.Exception
Open the object information page in a popup window

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
Saves the data field changes to the data provider.

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

onAssign

public void onAssign(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws java.lang.Exception
Show the select object pages to allow the user to navigate (or search) for an object to assign to the current array index.

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.

onAssignReference

public void onAssignReference(javax.servlet.http.HttpServletRequest request,
                              javax.servlet.http.HttpServletResponse response)
                       throws java.lang.Exception
Show the select file page to allow the user to select an URL or UNC type of attachment for the current index.

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.

onAddTemplate

public void onAddTemplate(javax.servlet.http.HttpServletRequest request,
                          javax.servlet.http.HttpServletResponse response)
                   throws java.lang.Exception
Show the Entry Template Wizard to allow the user to add a new object using the template and then add the newly added object to the end of the array.

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.

onReplaceTemplate

public void onReplaceTemplate(javax.servlet.http.HttpServletRequest request,
                              javax.servlet.http.HttpServletResponse response)
                       throws java.lang.Exception
Show the Entry Template Wizard to allow the user to add a new object using the template and then replace the Entry Template attachment item with the newly added object.

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.

onAddFormTemplate

public void onAddFormTemplate(javax.servlet.http.HttpServletRequest request,
                              javax.servlet.http.HttpServletResponse response)
                       throws java.lang.Exception
Show the Form Template Page to allow the user to add a new object using the template and then add the newly added object to the end of the array.

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.

onReplaceFormTemplate

public void onReplaceFormTemplate(javax.servlet.http.HttpServletRequest request,
                                  javax.servlet.http.HttpServletResponse response)
                           throws java.lang.Exception
Show the Form Template page to allow the user to add a new object using the template and then replace the Form Template attachment item with the newly added Form Data.

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.

onUnassign

public void onUnassign(javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response)
                throws java.lang.Exception
Remove the select item from the attachment items list and specify location as unassigned.

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.

onRemove

public void onRemove(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws java.lang.Exception
Remove the select item from the attachment items list completely.

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.

addAttachment

public void addAttachment(java.lang.String attachmentName,
                          java.lang.String objectStoreName,
                          java.lang.String objectId,
                          java.lang.String verSerId,
                          java.lang.String objectType)
                   throws java.lang.Exception
Add or assign the selected attachment (document, folder, or search) to the current attachments list.

Parameters:
objectStoreName - ObjectStore Name of the attached item.
objectId - Object Id of the attached item (for a specific version).
verSerId - Version Series Id of the attached item.
objectType - String type of the selected object (document, folder, storedsearch, versionseries)
Throws:
java.lang.Exception - If there are problems retrieving data.

addReferenceAttachment

public void addReferenceAttachment(java.lang.String attachmentName,
                                   java.lang.String type,
                                   java.lang.String path)
                            throws java.lang.Exception
Add or assign the selected attachment (document, folder, or search) to the current attachments list.

Parameters:
attachmentName - The selected attachment name
type - The type of attachment "unc" of "url".
path - The path to the external file
Throws:
java.lang.Exception - If there are problems retrieving data.

removeAttachment

public void removeAttachment(java.lang.String attachmentName,
                             java.lang.String objectStoreName,
                             java.lang.String objectId,
                             java.lang.String verSerId,
                             java.lang.String objectType,
                             java.lang.String position,
                             boolean unassign)
                      throws java.lang.Exception
Remove or unassign the selected attachment from the current attachments list.

The unassign parameter works as follows.

True causes the attachment item to be replaced by an unassigned item.
False causes the attachment item to be removed.

Parameters:
objectStoreName - ObjectStore Name of the attached item.
objectId - Object Id of the attached item.
verSerId - Version Series Id of the attached item (if appropriate object type).
objectType - String type of the selected object (document, folder, search).
position - String index into the displayed list of attachment items.
unassign - Boolean to indicate whether to completely remove the item of just change it to unassigned.
Throws:
java.lang.Exception - If there are problems retrieving data.

onSelectObject

public void onSelectObject(javax.servlet.http.HttpServletRequest request,
                           javax.servlet.http.HttpServletResponse response)
                    throws java.lang.Exception
Handle the select object event. The event is generated when the user navigates to the select object page and selects something.

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.

onSelectFile

public void onSelectFile(javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response)
                  throws java.lang.Exception
Handle the select file event. The event is generated when the user navigates to the select UNC or URL file page and selects something.

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.

buildSelectObjectURL

public java.lang.String buildSelectObjectURL()
                                      throws java.lang.Exception
Return the required Url string for the Select Object page.

Returns:
String Url path to Select Object page.
Throws:
java.lang.Exception

buildSelectFileURL

public java.lang.String buildSelectFileURL()
                                    throws java.lang.Exception
Return the required Url string for the Select Object page.

Returns:
String Url path to Select Object page.
Throws:
java.lang.Exception

cleanup

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

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

panelSave

public void panelSave(javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response)
               throws java.lang.Exception
Signals the UI module to persist the incoming form data to its current state.

Specified by:
panelSave in interface com.filenet.wcm.toolkit.server.base.WcmPanelInterface
Parameters:
request - HttpServletRequest is the jsp request object.
response - HttpServletResponse is the jsp response object.
Throws:
java.lang.Exception - If there are problems.

panelValidate

public boolean panelValidate()
                      throws java.lang.Exception
Called on a page to check any entered data to confirm that everything is valid.

Specified by:
panelValidate in interface com.filenet.wcm.toolkit.server.base.WcmPanelValidationInterface
Returns:
boolean flag set to true if no validation erros otherwise false.
Throws:
java.lang.Exception

panelFinish

public void panelFinish(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Signals the UI module to commit its state to the data provider.

Specified by:
panelFinish in interface com.filenet.wcm.toolkit.server.base.WcmPanelInterface
Parameters:
request - HttpServletRequest is the jsp request object.
response - HttpServletResponse is the jsp response object.
Throws:
java.lang.Exception - If there are problems.

setPageInfo

public void setPageInfo(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Set the cached page data into the step element object. Step Element is not actually saved until doSave() method is called sometime later.

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.

isModified

public boolean isModified()
                   throws java.lang.Exception
Return true if the Fields or Groups state has changed as a result of a panelSave call.

Specified by:
isModified in interface com.filenet.wcm.toolkit.server.base.WcmViewPanelInterface
Returns:
false
Throws:
java.lang.Exception - If there are problems.

isAttachmentsModified

public boolean isAttachmentsModified()
                              throws java.lang.Exception
Return true if the Attachments state has changed as a result of a panelSave call.

Returns:
false
Throws:
java.lang.Exception - If there are problems.

setIsModified

public void setIsModified(boolean modified)
                   throws java.lang.Exception
Set the modified state. Checks to see if the state is currently modified. If the state is currently modified, nothing is set, otherwise the value is set to what is being passed in.

Parameters:
modified - boolean value to set.
Throws:
java.lang.Exception - If there are problems.

setIsAttachmentModified

public void setIsAttachmentModified(boolean modified)
                             throws java.lang.Exception
Set the modified state. Checks to see if the state is currently modified. If the state is currently modified, nothing is set, otherwise the value is set to what is being passed in.

Parameters:
modified - boolean value to set.
Throws:
java.lang.Exception - If there are problems.

isApplyButtonRequired

public boolean isApplyButtonRequired()
                              throws java.lang.Exception
Implement, and return "true" if you want the WcmInfo container to show an "Apply" button. When Apply is pressed by the user, the UI module will get a call to wizardFinish.

Specified by:
isApplyButtonRequired in interface com.filenet.wcm.toolkit.server.base.WcmViewPanelInterface
Returns:
true - Apply button required
Throws:
java.lang.Exception - If there are problems.

getFormName

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

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

setLocale

public void setLocale(java.util.Locale locale)
Set the locale

Parameters:
locale - Locale

getValidationErrors

public java.util.Iterator getValidationErrors()
Specified by:
getValidationErrors in interface com.filenet.wcm.toolkit.server.base.WcmPanelValidationInterface


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