Namespace: Consultingwerk.SmartFramework.System
Class 
CommentDatasetController Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.SmartFramework.System.CommentDatasetController

Inherits: Progress.Lang.Object
Implements: Consultingwerk.SmartComponents.Interfaces.IDatasetController


Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
ClearListView () Clears the List View
INTEGER CommentRoleCount () Returns the number of comment roles
CHARACTER CommentRoleName (character) Returns the name of the comment role
CHARACTER CreateComment (character, character, longchar) Creates a new comment for the current parent record
DeleteComment (character) Deletes a comment
DeregisterConsumer (Object) Invoked by SmartBusinessEntityAdapter and SmartDatasetChildAdapter instances when detaching from the Dataset of the DatasetController. Allows event unsubscription etc.
CHARACTER FirstCommentRoleGuid () Returns the key of the first comment role
LOGICAL GetCommentInfo (character, character, character) Returns the title and the comment role of a comment in the dataset
LONGCHAR LoadCommentData (character) Returns the RTF text of a comment
LoadCommentRoles () Loads the comment roles from the ICommentRoleProvider service
PopulateListView () Populates the ListView with the comments of the current record
CHARACTER ProposeTitle (character) Proposes a title for a new comment
RegisterConsumer (Object) Invoked by SmartBusinessEntityAdapter and SmartDatasetChildAdapter instances when attaching to the Dataset of the DatasetController. Allows event subscription etc.
LOGICAL SaveComment (character, character, character, longchar) Saves the title, the comment role and the RTF text of an existing comment
LOGICAL TitleExists (character, character) Returns if a comment with the given title already exists for the current record

Top Constructor Summary
Options Name Purpose
CommentDatasetController () Constructor of the CommentDatasetController class

Top Property Summary
Options Name Purpose
HANDLE DatasetHandle
Infragistics.Win.UltraWinListView.UltraListView ListView


Method Detail
Top

ClearListView ()
Purpose: Clears the List View
Notes:

Top

INTEGER CommentRoleCount ()
Purpose: Returns the number of comment roles
Notes:

Returns INTEGER
The number of comment roles
Top

CHARACTER CommentRoleName (character)
Purpose: Returns the name of the comment role
Notes: Returns an empty string when the comment role is not known

Parameters:
pcCommentRoleGuid CHARACTER
The GUID of the comment role
Returns CHARACTER
The name of the comment role
Top

CHARACTER CreateComment (character, character, longchar)
Purpose: Creates a new comment for the current parent record
Notes: Assigns TableGUID and RecordKeyValue the same way as attachments
are created. The AttachmentDataAccess resolves the real SmartTable
GUID during save

Parameters:
pcTitle CHARACTER
The title of the comment (stored in AttachmentName)
pcCommentRoleGuid CHARACTER
The GUID of the comment role
plcCommentData LONGCHAR
The RTF text of the comment
Returns CHARACTER
The AttachmentGUID of the new comment
Top

DeleteComment (character)
Purpose: Deletes a comment
Notes:

Parameters:
pcAttachmentGuid CHARACTER
The AttachmentGUID of the comment to delete
Top

DeregisterConsumer (Object)
Purpose: Invoked by SmartBusinessEntityAdapter and SmartDatasetChildAdapter
instances when detaching from the Dataset of the DatasetController.
Allows event unsubscription etc.
Notes: Interface IDatasetController member

Parameters:
poConsumer Progress.Lang.Object
The reference of the Object detaching from the Dataset Controller
Top

CHARACTER FirstCommentRoleGuid ()
Purpose: Returns the key of the first comment role
Notes: Returns an empty string when no comment role is defined

Returns CHARACTER
The GUID of the first comment role
Top

LOGICAL GetCommentInfo (character, character, character)
Purpose: Returns the title and the comment role of a comment in the dataset
Notes:

Parameters:
pcAttachmentGuid CHARACTER
The AttachmentGUID of the comment
pcTitle CHARACTER
OUTPUT The title of the comment
pcCommentRoleGuid CHARACTER
OUTPUT The GUID of the comment role
Returns LOGICAL
Logical value indicating if the comment was found
Top

LONGCHAR LoadCommentData (character)
Purpose: Returns the RTF text of a comment
Notes: Fetches the CommentData CLOB through the GetLargeObjects method
of the AttachmentBusinessEntity, as the default binding of the
AttachmentDataAccess excludes the LOB fields

Parameters:
pcAttachmentGuid CHARACTER
The AttachmentGUID of the comment
Returns LONGCHAR
The RTF text of the comment
Top

LoadCommentRoles ()
Purpose: Loads the comment roles from the ICommentRoleProvider service
Notes: The comment roles are read once per instance

Top

PopulateListView ()
Purpose: Populates the ListView with the comments of the current record
Notes: Only rows with a CommentRoleGUID are comments

Top

CHARACTER ProposeTitle (character)
Purpose: Proposes a title for a new comment
Notes: The proposal consists of the name of the comment role and the
current date and time. The user may overwrite it before saving

Parameters:
pcCommentRoleGuid CHARACTER
The GUID of the comment role
Returns CHARACTER
The proposed title
Top

RegisterConsumer (Object)
Purpose: Invoked by SmartBusinessEntityAdapter and SmartDatasetChildAdapter
instances when attaching to the Dataset of the DatasetController.
Allows event subscription etc.
Notes: Interface IDatasetController member

Parameters:
poConsumer Progress.Lang.Object
The reference of the Object attaching to the Dataset Controller
Top

LOGICAL SaveComment (character, character, character, longchar)
Purpose: Saves the title, the comment role and the RTF text of an existing
comment
Notes:

Parameters:
pcAttachmentGuid CHARACTER
The AttachmentGUID of the comment
pcTitle CHARACTER
The title of the comment (stored in AttachmentName)
pcCommentRoleGuid CHARACTER
The GUID of the comment role
plcCommentData LONGCHAR
The RTF text of the comment
Returns LOGICAL
Logical value indicating if the comment was found and saved
Top

LOGICAL TitleExists (character, character)
Purpose: Returns if a comment with the given title already exists for the
current record
Notes: The title is part of the primary unique index of the SmartAttachment
table (TableGUID, RecordKeyValue, AttachmentFolder, AttachmentName)

Parameters:
pcTitle CHARACTER
The title to verify
pcExcludeAttachmentGuid CHARACTER
The AttachmentGUID of the comment that is currently edited (excluded from the check)
Returns LOGICAL
Logical value indicating if another comment with the title exists


Constructor Detail
Top

CommentDatasetController ()
Purpose: Constructor of the CommentDatasetController class
Notes: Assigns the DatasetHandle property



Property Detail
Top

HANDLE DatasetHandle

Returns HANDLE
Top

Infragistics.Win.UltraWinListView.UltraListView ListView

Returns Infragistics.Win.UltraWinListView.UltraListView


Temp-Table Detail


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       19.09.2026 10:15:21