|
||||||||||
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.WcmAttachmentInfoPage
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 |
public WcmAttachmentInfoPage(int processorType) throws java.lang.Exception
processorType
- Operation type (step processor, launch step processor or queue information)
java.lang.Exception
- If there are problems.for processorType options
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
- HttpServletRequest is the Java™Server Pages (JSP) request object.response
- HttpServletResponse is the JSP response object.
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 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 boolean getAttachmentIsArray(java.lang.String attachmentName) throws java.lang.Exception
The return value works as follows.
True if he attachment is an array.
False if the attachment is a single element.
attachmentName
- String attachment name.
java.lang.Exception
- Thrown when there are errors.public void setApplyButtonRequired(boolean applyButtonRequired)
applyButtonRequired
- boolean indicating whether to expose the Apply command.public WcmAttachmentNavigation getAttachmentNavigation()
public WcmAttachmentsListView getAttachmentsListView()
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
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
java.lang.Exception
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
public boolean isApplyButtonRequired() throws java.lang.Exception
isApplyButtonRequired
in interface com.filenet.wcm.toolkit.server.base.WcmViewPanelInterface
java.lang.Exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |