Latest revision as of 07:44, 2 July 2020

ResourceJournalEntry

A resource journal entry

Parent class

Inherits from object

Constructors

(int Comment Id "Comment Id") - Load existing journal entry
(int Resource Id "Comment to what resource", string journalType "What kind of journal type is it", string content "What does the comment say") - Create a new comment object. Use Resource_addJournal or .Save() to save. Creating user is current user. Use addJournal() if dealing with tasks.

Methods

Empty Destroy() - Permanently delete the current comment
Empty Save() - Save the current comment
(From object) string ToString() - The string representation of the object.

Properties

string CommentType { get; } - Get the comment type as string
string Content { get; set; } - Get/set the comment content
int CreatedByUserResourceId { get; } - Get CreatedByUserResourceId
DateTime CreatedDate { get; } - Get CreatedDate
int Id { get; } - Comment Id
int ModifiedByUserResourceId { get; } - Get ModifiedByUserResourceId
DateTime ModifiedDate { get; } - Get ModifiedDate
string ObjectTypeName { get; } - The name of the type of object.
(From object) TypeInformation TypeInformation { get; } - Get information about this class.

Notes

The CommentType of the object use below values:

Description
Proposal
Comment
Reassignment
Outcome
Disapproval
Cancellation
Rejection
NotAcceptRejection
Acceptance
Approval
Mergence
UndoComplete

@@ Line 2: / Line 2: @@
 |Name=<nowiki>ResourceJournalEntry</nowiki>
 |Description=<nowiki>A resource journal entry</nowiki>
-|Constructors=
+|InheritsFrom=object|Constructors=
 {{CGscriptConstructors_Template|Parameters=
-{{CGscriptParameters_Template|Type=number|Name=<nowiki>Resource Id</nowiki>|Description=<nowiki>Comment to what resource</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>journalType</nowiki>|Description=<nowiki>What kind of journal type is it</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>content</nowiki>|Description=<nowiki>What does the comment say</nowiki>}}
+{{CGscriptParameters_Template|Type=int|Name=<nowiki>Comment Id</nowiki>|Description=<nowiki>Comment Id</nowiki>}}
+|Description=<nowiki>Load existing journal entry</nowiki>}}
+{{CGscriptConstructors_Template|Parameters=
+{{CGscriptParameters_Template|Type=int|Name=<nowiki>Resource Id</nowiki>|Description=<nowiki>Comment to what resource</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>journalType</nowiki>|Description=<nowiki>What kind of journal type is it</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>content</nowiki>|Description=<nowiki>What does the comment say</nowiki>}}
 |Description=<nowiki>Create a new comment object. Use Resource_addJournal or .Save() to save. Creating user is current user. Use addJournal() if dealing with tasks.</nowiki>}}
 |Methods=
+{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Destroy</nowiki>|Description=<nowiki>Permanently delete the current comment</nowiki>}}
 {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Save</nowiki>|Description=<nowiki>Save the current comment</nowiki>}}
-{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
+{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Inherited=object|Description=<nowiki>The string representation of the object.</nowiki>}}
 |Properties=
 {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>CommentType</nowiki>|HasGetter=1|Description=<nowiki>Get the comment type as string</nowiki>}}
 {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Content</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set the comment content</nowiki>}}
-{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>CreatedByUserResourceId</nowiki>|HasGetter=1|Description=<nowiki>Get CreatedByUserResourceId</nowiki>}}
+{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>CreatedByUserResourceId</nowiki>|HasGetter=1|Description=<nowiki>Get CreatedByUserResourceId</nowiki>}}
 {{CGscriptProperties_Template|ReturnType=DateTime|Name=<nowiki>CreatedDate</nowiki>|HasGetter=1|Description=<nowiki>Get CreatedDate</nowiki>}}
-{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>ModifiedByUserResourceId</nowiki>|HasGetter=1|Description=<nowiki>Get ModifiedByUserResourceId</nowiki>}}
+{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>Id</nowiki>|HasGetter=1|Description=<nowiki>Comment Id</nowiki>}}
+{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>ModifiedByUserResourceId</nowiki>|HasGetter=1|Description=<nowiki>Get ModifiedByUserResourceId</nowiki>}}
 {{CGscriptProperties_Template|ReturnType=DateTime|Name=<nowiki>ModifiedDate</nowiki>|HasGetter=1|Description=<nowiki>Get ModifiedDate</nowiki>}}
 {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
-{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
+{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Inherited=object|Description=<nowiki>Get information about this class.</nowiki>}}
 }}
+==== Notes ====
+The CommentType of the object use below values:
+*Description
+*Proposal
+*Comment
+*Reassignment
+*Outcome
+*Disapproval
+*Cancellation
+*Rejection
+*NotAcceptRejection
+*Acceptance
+*Approval
+*Mergence
+*UndoComplete