com.filenet.wcm.apps.server.ui.info
Class WcmAttachmentInfoPage

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.WcmAttachmentInfoPage
All Implemented Interfaces:
com.filenet.wcm.toolkit.server.base.WcmModuleInterface, com.filenet.wcm.toolkit.server.base.WcmPanelInterface, com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface, com.filenet.wcm.toolkit.server.base.WcmViewPanelInterface

public class WcmAttachmentInfoPage
extends com.filenet.wcm.toolkit.server.base.WcmUiModule
implements com.filenet.wcm.toolkit.server.base.WcmViewPanelInterface

Display the attachments in the Path, Navigation and List module format.


Field Summary
 
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
NAME_DELIMITER
 
Constructor Summary
WcmAttachmentInfoPage(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.
 boolean getAttachmentIsArray(java.lang.String attachmentName)
          Return whether the specified attachment is of type array.
 WcmAttachmentNavigation getAttachmentNavigation()
          Accessor method to return the WcmAttachmentNavigation object.
 WcmAttachmentsListView getAttachmentsListView()
          Accessor method to return the WcmAttachmentsListView object.
protected  java.lang.String getExecuteKey()
          Accessor method for getting the Executed Add key.
 void initialize()
          Initializes the class data and the XSL parameters for the associated XSL file.
 boolean isApplyButtonRequired()
           
 boolean isModified()
           
 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 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 onSelectFile(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Handle the select file event.
 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)
          Add the appropriate command Button to the toolbar.
 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)
           
 void panelSave(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 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 setApplyButtonRequired(boolean applyButtonRequired)
          Sets the display state of the Apply command.
 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, getFormName, 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, 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
 

Constructor Detail

WcmAttachmentInfoPage

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

Parameters:
processorType - Operation type (step processor, launch step processor or queue information)
Throws:
java.lang.Exception - If there are problems.
See Also:
for processorType options
Method Detail

initialize

public void initialize()
                throws java.lang.Exception
Initializes the class data and the XSL parameters for the associated XSL file.

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
Add the appropriate command Button to the toolbar.

Specified by:
onStartPage in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Parameters:
request - HttpServletRequest is the Java™Server Pages (JSP) request object.
response - HttpServletResponse is the JSP response object.
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.

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

getAttachmentIsArray

public boolean getAttachmentIsArray(java.lang.String attachmentName)
                             throws java.lang.Exception
Return whether the specified attachment is of type array.

The return value works as follows.

True if he attachment is an array.
False if the attachment is a single element.

Parameters:
attachmentName - String attachment name.
Returns:
boolean Whether the attachment is of type array.
Throws:
java.lang.Exception - Thrown when there are errors.

setApplyButtonRequired

public void setApplyButtonRequired(boolean applyButtonRequired)
Sets the display state of the Apply command.

Parameters:
applyButtonRequired - boolean indicating whether to expose the Apply command.

getAttachmentNavigation

public WcmAttachmentNavigation getAttachmentNavigation()
Accessor method to return the WcmAttachmentNavigation object.

Returns:
WcmAttachmentNavigation object.

getAttachmentsListView

public WcmAttachmentsListView getAttachmentsListView()
Accessor method to return the WcmAttachmentsListView object.

Returns:
WcmAttachmentsListView object.

panelSave

public void panelSave(javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response)
               throws java.lang.Exception
Specified by:
panelSave in interface com.filenet.wcm.toolkit.server.base.WcmPanelInterface
Throws:
java.lang.Exception

panelFinish

public void panelFinish(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Specified by:
panelFinish in interface com.filenet.wcm.toolkit.server.base.WcmPanelInterface
Throws:
java.lang.Exception

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
Specified by:
isModified in interface com.filenet.wcm.toolkit.server.base.WcmViewPanelInterface
Throws:
java.lang.Exception

isApplyButtonRequired

public boolean isApplyButtonRequired()
                              throws java.lang.Exception
Specified by:
isApplyButtonRequired in interface com.filenet.wcm.toolkit.server.base.WcmViewPanelInterface
Throws:
java.lang.Exception


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