IBM FileNet P8, Version 5.2.1            

Comment Base Class and Subclass

The Comment base class (ClbAbstractComment) and its subclass define user-creatable comments associated with a document.

The following subclass derives from the Comment base class: Document Comment.

You can view the base class and subclasses in the Administration Console for Content Platform Engine, under the object store navigation pane. Go to Data Design > Classes > Other Classes > Abstract Persistable > Abstract Comment.

Comment base class

The Comment class (ClbAbstractComment) represents the base abstract class for document comments.

Class metadata:
  • Allows instances: false
  • Hidden: false
  • Subclassed from: Abstract Persistable (CmAbstractPersistable) class
Table 1. Custom properties on the Comment base class
Column Name Property Description
Comment Text (ClbCommentText) Long String

Value required
Max length = 65535
Read/write

Only creator can edit.

Commented Version Series (ClbCommentedVersionSeries) Singleton Object Supports query for comments that are associated with a document version series.

Value required, set by server.
Set on create only.
Required class = VersionSeries
Security proxy = false
Index for queries.

In Reply To (ClbInReplyTo) Singleton Object References comment OVP to which this comment is a reply.

Part of reflective cascade delete relationship with ClbReplies enumeration.

Read/write
Value required = false
Security proxy = false
Required class = ClbAbstactComment

Replies(ClbReplies>) Enumeration of ClbAbstractComment objects

Value required, set by server.
Set on create only.

Originator (ClbOriginator) String SID of user that creates comment.

Value required = true
Max length=400
Set on create by server.

Document Comment class

The Document Comment (ClbDocumentComment) class represents an end-user comment on a document.

Class metadata:
  • Allows instances: true
  • Hidden: false
  • Subclassed from: Abstract Comment (ClbAbstractComment) class
Table 2. Custom Properties on the Document Comment class
Column Name Property Description
Commented Document (ClbCommentedDocument) Singleton Object Configure the target access that is required for this property to AccessRight.VIEW_CONTENT

Value required = true
Required class = Document
Security proxy = false
Set on create only.

Summary Data (ClbSummaryData) Singleton Object Part of reflective relationship between ClbSummaryData and ClbDocumentComment objects.

This relationship supports CASCADE DELETE.

Value required, set by server.
Set on create only.
Security proxy = true
Required class = ClbSummaryData

Document Major Version (ClbDocumentMajorVersion) Integer

Value required, set by server.
Set on create only.

Document Minor Version (ClbDocumentMinorVersion) Integer

Value required, set by server.
Set on create only.



Last updated: October 2015
socialCollab_comments_properties.htm

© Copyright IBM Corporation 2015.