CommentInfo

Name CommentInfo
Usage CommentService
getComment getCommentsByIds getCommentsByReferenceAndType searchForComments createComment updateComment validateComment
Type Complex

Description

Refer to interface javadoc

Structure Definition

ShortName Name Type Description Required? Read only? Cardinality XML Attribute? Implementation Notes
id Unique Id String The system assigned unique id to identify this Object.
Could be implemented as as sequence number or as a UUID.

Attempts to set this value on creates should result in a ReadOnlyException being thrown

An Id:

  • An id is used when the actual value is unimportant and
    can therefore be a large hex value for example

  • An id value might be 23b9ca9bd203df902

  • An Id is never intended to be used directly by an end
    user.

  • Ids are assumed to be of different values in different
    KS implementations

  • Id values are generated by the service
    implementations

  • Id values are never expected to be used in
    Configuration or Application code

 Required on updates Read only One Yes  
typeKey Type Key String A unique identifier for the type of this object. Required Read only One Yes  
stateKey State Key String A unique identifier for the state of this object. Required   One Yes  
commentText Comment Text RichTextInfo Narrative text of the comment Required   One No  
referenceTypeKey Reference Type Key String Unique identifier for a reference type. Required Read only One No  
referenceId Reference Id String Identifier component for a reference. This is an external identifier and such may not uniquely identify
a particular reference unless combined with the type. A referenceId could be a cluId, a luiId,
an orgId, a documentId, etc.		 Required Read only One No  
effectiveDate Effective Date Date Date and time that this comment became effective. This is a similar concept to the effective date on
enumerated values. When an expiration date has been specified, this field must be less than or equal
to the expiration date.		     One No  
expirationDate Expiration Date Date Date and time that this comment expires. This is a similar concept to the expiration date on
enumerated values. If specified, this should be greater than or equal to the effective date. If this field
is not specified, then no expiration date has been currently defined and should automatically be considered
greater than the effective date.		     One No  
meta Meta MetaInfo Create and last update info for the structure. This is optional
and treated as read only since the data is set by the internals
of the service during maintenance operations.

Contains audit trail information about the creation and last
update of this object Also contains the version ind used for
optimistic locking.

Attempts to set or update should result in a ReadOnlyException
being thrown.		 Required on updates Read only One No  
attributes Dynamic Attributes AttributeInfoList List of dynamic attributes, each holding a key-value pair that
can be configured to hold additional information for an
implementing institution.

Note: the key may be repeated more than once to simulate a list
of values.		     Many No