Decision Center API

ilog.rules.teamserver.brm
Interface IlrActivityUserComment

All Superinterfaces:
Cloneable, IlrActivityComment, IlrBasicModelElement, ilog.rules.teamserver.model.IlrCompositeObject, ilog.rules.commonbrm.model.IlrElement, IlrElementDetails, IlrElementHandle, IlrElementSummary, Serializable

public interface IlrActivityUserComment
extends IlrActivityComment

A representation of the model object 'Activity User Comment'.

The following features are supported:

See Also:
IlrBrmPackage.getActivityUserComment()

Method Summary
 List getAttachments()
          Returns the value of the 'Attachments' containment reference list.
 List getAttachments(IlrElementVersion version)
          Returns the value of the 'Attachments' containment reference list for the given version.
 List getLinks()
          Returns the value of the 'Links' containment reference list.
 List getLinks(IlrElementVersion version)
          Returns the value of the 'Links' containment reference list for the given version.
 IlrActivityComment getParent()
          Returns the value of the 'Parent' reference.
 String getText()
          Returns the value of the 'Text' attribute.
 List getVisibility()
          Returns the value of the 'Visibility' containment reference list.
 List getVisibility(IlrElementVersion version)
          Returns the value of the 'Visibility' containment reference list for the given version.
 
Methods inherited from interface ilog.rules.teamserver.brm.IlrActivityComment
getBaseline, getSourceRuleArtifact
 
Methods inherited from interface ilog.rules.teamserver.brm.IlrBasicModelElement
getCreatedBy, getCreatedOn, getLastChangedBy, getLastChangedOn
 
Methods inherited from interface ilog.rules.teamserver.model.IlrElementDetails
cloneElement, getContainer, getRawValue, setRawValue, setRawValueNoCheck
 
Methods inherited from interface ilog.rules.teamserver.model.IlrElementSummary
getName
 
Methods inherited from interface ilog.rules.teamserver.model.IlrElementHandle
eClass, equals, equals, getModelInfo, getSession, getType, getValue, hashCode, isNew, toIdString
 
Methods inherited from interface ilog.rules.commonbrm.model.IlrElement
getPropertyValue, getPropertyValue, isInstanceOf
 

Method Detail

getText

String getText()
Returns the value of the 'Text' attribute.

The default value is "".

If the meaning of the 'Text' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Text' attribute.
See Also:
IlrBrmPackage.getActivityUserComment_Text()

getParent

IlrActivityComment getParent()
                             throws IlrObjectNotFoundException
Returns the value of the 'Parent' reference.

If the meaning of the 'Parent' reference isn't clear, there really should be more of a description here...

Throws:
IlrObjectNotFoundException
Returns:
the value of the 'Parent' reference.
See Also:
IlrBrmPackage.getActivityUserComment_Parent()

getVisibility

List getVisibility()
                   throws IlrObjectNotFoundException
Returns the value of the 'Visibility' containment reference list.

The list contents are of type IlrActivityCommentAccess.

If the meaning of the 'Visibility' containment reference list isn't clear, there really should be more of a description here...

Throws:
IlrObjectNotFoundException
Returns:
the value of the 'Visibility' containment reference list.
See Also:
IlrBrmPackage.getActivityUserComment_Visibility()

getVisibility

List getVisibility(IlrElementVersion version)
                   throws IlrObjectNotFoundException
Returns the value of the 'Visibility' containment reference list for the given version. Allows to retrieve the value linked to a specific version. Useful when the working baseline is the current baseline.

The list contents are of type IlrActivityCommentAccess.

If the meaning of the 'Visibility' containment reference list isn't clear, there really should be more of a description here...

Throws:
IlrObjectNotFoundException
Parameters:
version - The version of the element.
Returns:
the value of the 'Visibility' containment reference list.
See Also:
IlrBrmPackage.getActivityUserComment_Visibility()

getAttachments

List getAttachments()
                    throws IlrObjectNotFoundException
Returns the value of the 'Attachments' containment reference list.

The list contents are of type IlrActivityCommentAttachment.

If the meaning of the 'Attachments' containment reference list isn't clear, there really should be more of a description here...

Throws:
IlrObjectNotFoundException
Returns:
the value of the 'Attachments' containment reference list.
See Also:
IlrBrmPackage.getActivityUserComment_Attachments()

getAttachments

List getAttachments(IlrElementVersion version)
                    throws IlrObjectNotFoundException
Returns the value of the 'Attachments' containment reference list for the given version. Allows to retrieve the value linked to a specific version. Useful when the working baseline is the current baseline.

The list contents are of type IlrActivityCommentAttachment.

If the meaning of the 'Attachments' containment reference list isn't clear, there really should be more of a description here...

Throws:
IlrObjectNotFoundException
Parameters:
version - The version of the element.
Returns:
the value of the 'Attachments' containment reference list.
See Also:
IlrBrmPackage.getActivityUserComment_Attachments()

getLinks

List getLinks()
              throws IlrObjectNotFoundException
Returns the value of the 'Links' containment reference list.

The list contents are of type IlrActivityCommentLink.

If the meaning of the 'Links' containment reference list isn't clear, there really should be more of a description here...

Throws:
IlrObjectNotFoundException
Returns:
the value of the 'Links' containment reference list.
See Also:
IlrBrmPackage.getActivityUserComment_Links()

getLinks

List getLinks(IlrElementVersion version)
              throws IlrObjectNotFoundException
Returns the value of the 'Links' containment reference list for the given version. Allows to retrieve the value linked to a specific version. Useful when the working baseline is the current baseline.

The list contents are of type IlrActivityCommentLink.

If the meaning of the 'Links' containment reference list isn't clear, there really should be more of a description here...

Throws:
IlrObjectNotFoundException
Parameters:
version - The version of the element.
Returns:
the value of the 'Links' containment reference list.
See Also:
IlrBrmPackage.getActivityUserComment_Links()

Decision Center API

© Copyright IBM Corp. 1987, 2013