Package com.polarion.alm.tracker.model

Interface ICommentBase<T extends ICommentBase<T>>

Type Parameters:

T - particular comment type

All Superinterfaces:

IAdaptable, IChangeListener, IHasCustomValues, IHasValues, IPObject, IUniqueObject

All Known Subinterfaces:

IComment, IModuleComment, IRichPageComment, ITestRunComment

public interface ICommentBase<T extends ICommentBase<T>>
extends IUniqueObject

Since:

3.5.0

Author:

Stepan Roh

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	ICommentBase.SortBy	Comment sorting type.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY_AUTHOR
static final String	KEY_CHILD_COMMENTS
static final String	KEY_CREATED
static final String	KEY_PARENT_COMMENT
static final String	KEY_RESOLVED
static final String	KEY_SIGNATURE_DATA
static final String	KEY_TAGS
static final String	KEY_TEXT
static final String	PROTO

Fields inherited from interface com.polarion.alm.projects.model.IUniqueObject

KEY_ID, KEY_PROJECT

Method Summary

Modifier and Type	Method	Description
com.polarion.platform.persistence.internal.ICommentPermissions	can()	Returns the permissions for this object
T	createChildComment(Text text)	Shortcut for createChildComment(text, true).
T	createChildComment(Text text, boolean reopen)	Creates a child comment and optionally reopens the comment thread, if it is resolved.
IUser	getAuthor()
IPObjectList<T>	getChildComments()
Date	getCreated()
T	getParentComment()
T	getRootComment()
ISignatureData	getSignatureData()	Signature related data.
IEnumSet<ICommentTagOpt>	getTags()
Text	getText()
ITrackerService	getTrackerService()
boolean	isResolvedComment()	Checks if this comment is in a resolved comments thread.
void	setResolvedComment(boolean resolved)	Sets the resolved state of this comment.
ISignatureData	setSignatureData(IWorkflowSignature workflowSignature, String workflowActionId)	Sets signature data.

Methods inherited from interface com.polarion.platform.persistence.model.IAdaptable

adapt

Methods inherited from interface com.polarion.platform.persistence.model.IChangeListener

markChanged

Methods inherited from interface com.polarion.platform.persistence.model.IHasCustomValues

getCustomField, getCustomFieldPrototype, getCustomFieldsList, setCustomField

Methods inherited from interface com.polarion.platform.persistence.model.IPObject

copyTo, createStructureForKey, forget, getContextId, getDataRevision, getDataSvc, getEnumerationOptionForField, getEnumerationTypeForField, getFieldLabel, getFieldType, getIncompatibleCustomField, getIncompatibleCustomFieldPrototype, getIncompatibleCustomFieldsList, getLastRevision, getLocalId, getObjectId, getPrototype, getRevision, getUri, getValue, isModified, isPersisted, isReadOnly, isResolved, isUnresolvable, resolve, save, setEnumerationValue, setValue, update

Methods inherited from interface com.polarion.alm.projects.model.IUniqueObject

getId, getProject, getProjectId

Field Details

PROTO

static final String PROTO

See Also:

• Constant Field Values

KEY_AUTHOR

static final String KEY_AUTHOR

See Also:

• Constant Field Values

KEY_CREATED

static final String KEY_CREATED

See Also:

• Constant Field Values

KEY_TEXT

static final String KEY_TEXT

See Also:

• Constant Field Values

KEY_PARENT_COMMENT

static final String KEY_PARENT_COMMENT

Since:

3.1.1

See Also:

• Constant Field Values

KEY_CHILD_COMMENTS

static final String KEY_CHILD_COMMENTS

Since:

3.1.1

See Also:

• Constant Field Values

KEY_TAGS

static final String KEY_TAGS

Since:

3.7.1

See Also:

• Constant Field Values

KEY_RESOLVED

static final String KEY_RESOLVED

Since:

3.7.1

See Also:

• Constant Field Values

KEY_SIGNATURE_DATA

@NotNull
static final String KEY_SIGNATURE_DATA

Since:

3.9.0

See Also:

• Constant Field Values

Method Details

getAuthor

IUser getAuthor()

getCreated

Date getCreated()

getText

@Nullable
Text getText()

getChildComments

@NotNull
IPObjectList<T> getChildComments()

Since:

3.1.1

getRootComment

@NotNull
T getRootComment()

Since:

3.1.1

getParentComment

@Nullable
T getParentComment()

Since:

3.1.1

createChildComment

@NotNull
T createChildComment(Text text)

Shortcut for createChildComment(text, true).

Since:

3.1.1

See Also:

• createChildComment(Text, boolean)

createChildComment

@NotNull
T createChildComment(Text text,
 boolean reopen)

Creates a child comment and optionally reopens the comment thread, if it is resolved. If the thread is reopened, IPObject.save() is called on the root comment.

Since:

3.7.1

getTags

IEnumSet<ICommentTagOpt> getTags()

Since:

3.7.1

setResolvedComment

void setResolvedComment(boolean resolved)

Sets the resolved state of this comment. Can be used only for the root comments.

Since:

3.7.1

isResolvedComment

boolean isResolvedComment()

Checks if this comment is in a resolved comments thread.

Since:

3.7.1

getSignatureData

@Nullable
ISignatureData getSignatureData()

Signature related data.

Since:

3.9.0

See Also:

• ICommentTagOpt.OPT_SIGNATURES

setSignatureData

@NotNull
ISignatureData setSignatureData(@NotNull
 IWorkflowSignature workflowSignature,
 @Nullable
 String workflowActionId)

Sets signature data. Adds the tag ICommentTagOpt.OPT_SIGNATURES if it is missing.

Returns:

the created signature data

Since:

3.9.0

can

@NotNull
com.polarion.platform.persistence.internal.ICommentPermissions can()

Returns the permissions for this object

Specified by:

can in interface IPObject

Since:

3.8.2

getTrackerService

@NotNull
ITrackerService getTrackerService()

Since:

3.10.0