Class icm.dialog.addcommentdialog.AddCommentDialog

Extends ecm.widget.dialog.BaseDialog.
Represents the Add Comment dialog box that displays the comments for a case, document, or work item. Case workers use this dialog box to review the comments and add new comments.
Defined in: <icm/dialog/addcommentdialog/AddCommentDialog.js>.

Constructor Summary

Constructor Attributes	Constructor Name and Description
	icm.dialog.addcommentdialog.AddCommentDialog()

Method Summary

Method Attributes	Method Name and Description
	constructor(artifactType, artifactLabel, commentContext, caseModel, documentTitle, docId, workItem) Constructs an Add Comment dialog box.
	shouldConfirmCancel() Determines whether the dialog box can be closed.

Method Detail

constructor(artifactType, artifactLabel, commentContext, caseModel, documentTitle, docId, workItem)

Parameters:

artifactType

Required parameter. One of the following values that indicate the type of object with which the comments are associated: "Document", "Case", "Workitem"

artifactLabel

Required parameter. A string value that is used to display the title of the document, case, or work item.

commentContext

Required parameter. An integer value that represents the action that is being taken when a comment is created.

caseModel

Required parameter for artifactType "Case". The icm.model.Case object for the case with which the comments are associated.

documentTitle

Required parameter for artifactType "Document". The title of the document with which the comments are associated.

docId

Required parameter for artifactType "Document". The version series ID of the IBM FileNet P8 document or the PID of the IBM Content Manager document with which the comments are associated.

workItem

Required parameter for artifactType "WorkItem". An icm.model.WorkItem object storing the WorkItem object with which the comments are associated.

---

shouldConfirmCancel()

Returns:

true if the dialog box can be closed; otherwise, returns false.

---