|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.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.apps.server.ui.info.processors.TaskInfoPage
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 |
protected static final java.lang.String name
protected static final java.lang.String formName
protected com.filenet.wcm.toolkit.server.dp.WcmEProcessDataProvider edp
protected com.filenet.wcm.toolkit.server.dp.WcmAuthoringDataProvider adp
protected com.filenet.wcm.toolkit.server.util.WcmStepElementState stepElementState
protected com.filenet.wcm.toolkit.server.util.WcmEProcessUtil eProcessUtil
protected EProcessMultilingualUtil eProcessMultilingualUtil
protected TaskHeaderModule taskHeader
protected TaskAttachmentsListView taskAttachments
protected TaskParameterModule taskParameter
protected TaskFooterModule taskFooter
protected int processorType
protected org.w3c.dom.Document xmlDoc
Constructor Detail |
public TaskInfoPage(int processorType) throws java.lang.Exception
processorType
- Operation type (step processor or launch step processor)
java.lang.Exception
Method Detail |
public void initialize() throws java.lang.Exception
initialize
in interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface
java.lang.Exception
- If there are problems.public void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
onStartPage
in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
request
- The Java™Server Pages (JSP) request object HttpServletRequestresponse
- The JSP response object HttpServletResponse
java.lang.Exception
- If there are problems retrieving data.protected java.lang.String getExecuteKey()
public void render(java.io.Writer w) throws java.lang.Exception
render
in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
w
- Writer for writing to the response object.
java.lang.Exception
- If there are problems.public void onSelectField(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
request
- The jsp request object HttpServletRequestresponse
- The jsp response object HttpServletResponse
java.lang.Exception
public void onSelectGroup(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
request
- The jsp request object HttpServletRequestresponse
- The jsp response object HttpServletResponse
java.lang.Exception
public void onSelectAttachment(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
request
- The jsp request object HttpServletRequestresponse
- The jsp response object HttpServletResponse
java.lang.Exception
public void onGroupModified(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
request
- The jsp request object HttpServletRequestresponse
- The jsp response object HttpServletResponse
java.lang.Exception
public void onGetInfo(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
request
- The jsp request object HttpServletRequestresponse
- The jsp response object HttpServletResponse
java.lang.Exception
public void onSubmit(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
request
- The jsp request object HttpServletRequestresponse
- The jsp response object HttpServletResponse
java.lang.Exception
public void onAssign(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
request
- HttpServletRequest is the JSP request object.response
- HttpServletResponse is the JSP response object.
java.lang.Exception
- If there are problems retrieving data.public void onAssignReference(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
request
- HttpServletRequest is the JSP request object.response
- HttpServletResponse is the JSP response object.
java.lang.Exception
- If there are problems retrieving data.public void onAddTemplate(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
request
- HttpServletRequest is the JSP request object.response
- HttpServletResponse is the JSP response object.
java.lang.Exception
- If there are problems retrieving data.public void onReplaceTemplate(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
request
- HttpServletRequest is the JSP request object.response
- HttpServletResponse is the JSP response object.
java.lang.Exception
- If there are problems retrieving data.public void onAddFormTemplate(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
request
- HttpServletRequest is the JSP request object.response
- HttpServletResponse is the JSP response object.
java.lang.Exception
- If there are problems retrieving data.public void onReplaceFormTemplate(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
request
- HttpServletRequest is the JSP request object.response
- HttpServletResponse is the JSP response object.
java.lang.Exception
- If there are problems retrieving data.public void onUnassign(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
request
- HttpServletRequest is the JSP request object.response
- HttpServletResponse is the JSP response object.
java.lang.Exception
- If there are problems retrieving data.public void onRemove(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
request
- HttpServletRequest is the JSP request object.response
- HttpServletResponse is the JSP response object.
java.lang.Exception
- If there are problems retrieving data.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
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)
java.lang.Exception
- If there are problems retrieving data.public void addReferenceAttachment(java.lang.String attachmentName, java.lang.String type, java.lang.String path) throws java.lang.Exception
attachmentName
- The selected attachment nametype
- The type of attachment "unc" of "url".path
- The path to the external file
java.lang.Exception
- If there are problems retrieving data.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
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.
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.
java.lang.Exception
- If there are problems retrieving data.public void onSelectObject(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
request
- HttpServletRequest is the JSP request object.response
- HttpServletResponse is the JSP response object.
java.lang.Exception
- If there are problems retrieving data.public void onSelectFile(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
request
- HttpServletRequest is the JSP request object.response
- HttpServletResponse is the JSP response object.
java.lang.Exception
- If there are problems retrieving data.public java.lang.String buildSelectObjectURL() throws java.lang.Exception
java.lang.Exception
public java.lang.String buildSelectFileURL() throws java.lang.Exception
java.lang.Exception
public void cleanup() throws java.lang.Exception
cleanup
in interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface
java.lang.Exception
- If there are problems.public void panelSave(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
panelSave
in interface com.filenet.wcm.toolkit.server.base.WcmPanelInterface
request
- HttpServletRequest is the jsp request object.response
- HttpServletResponse is the jsp response object.
java.lang.Exception
- If there are problems.public boolean panelValidate() throws java.lang.Exception
panelValidate
in interface com.filenet.wcm.toolkit.server.base.WcmPanelValidationInterface
java.lang.Exception
public void panelFinish(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
panelFinish
in interface com.filenet.wcm.toolkit.server.base.WcmPanelInterface
request
- HttpServletRequest is the jsp request object.response
- HttpServletResponse is the jsp response object.
java.lang.Exception
- If there are problems.public void setPageInfo(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws java.lang.Exception
request
- HttpServletRequest is the JSP request object.response
- HttpServletResponse is the JSP response object.
java.lang.Exception
- If there are problems retrieving data.public boolean isModified() throws java.lang.Exception
isModified
in interface com.filenet.wcm.toolkit.server.base.WcmViewPanelInterface
java.lang.Exception
- If there are problems.public boolean isAttachmentsModified() throws java.lang.Exception
java.lang.Exception
- If there are problems.public void setIsModified(boolean modified) throws java.lang.Exception
modified
- boolean value to set.
java.lang.Exception
- If there are problems.public void setIsAttachmentModified(boolean modified) throws java.lang.Exception
modified
- boolean value to set.
java.lang.Exception
- If there are problems.public boolean isApplyButtonRequired() throws java.lang.Exception
isApplyButtonRequired
in interface com.filenet.wcm.toolkit.server.base.WcmViewPanelInterface
java.lang.Exception
- If there are problems.public java.lang.String getFormName()
getFormName
in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
public void setLocale(java.util.Locale locale)
locale
- Localepublic java.util.Iterator getValidationErrors()
getValidationErrors
in interface com.filenet.wcm.toolkit.server.base.WcmPanelValidationInterface
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |