Package com.polarion.alm.tracker.model

Interface IModuleComment

All Superinterfaces:

IAdaptable, IChangeListener, ICommentBase<IModuleComment>, IHasCustomValues, IHasValues, IPObject, IUniqueObject

public interface IModuleComment
extends ICommentBase<IModuleComment>

Author:

Stepan Roh

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IModuleComment.IImportedCommentStruct

Nested classes/interfaces inherited from interface com.polarion.alm.tracker.model.ICommentBase

ICommentBase.SortBy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY_IMPORTED_COMMENT
static final String	KEY_MODULE
static final String	KEY_REFERRED_WORK_ITEM	Specifies to which work item this comment refers.
static final String	PROTO

Fields inherited from interface com.polarion.alm.tracker.model.ICommentBase

KEY_AUTHOR, KEY_CHILD_COMMENTS, KEY_CREATED, KEY_PARENT_COMMENT, KEY_RESOLVED, KEY_SIGNATURE_DATA, KEY_TAGS, KEY_TEXT

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

KEY_ID, KEY_PROJECT

Method Summary

Modifier and Type	Method	Description
IModuleComment	createChildComment(Text text)	Shortcut for createChildComment(text, true).
IModuleComment	createChildComment(Text text, boolean reopen)	Creates a child comment and optionally reopens the comment thread, if it is resolved.
IModuleComment.IImportedCommentStruct	createImportedComment(String author, String initials, Date created)
IModuleComment.IImportedCommentStruct	getImportedComment()
IModule	getModule()
IModuleComment	getParentComment()
IWorkItem	getReferredWorkItem()	see KEY_REFERRED_WORK_ITEM, can return null
IModuleComment	getRootComment()
void	setReferredWorkItem(IWorkItem value)	see KEY_REFERRED_WORK_ITEM, can be called only on root comment

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.alm.tracker.model.ICommentBase

can, getAuthor, getChildComments, getCreated, getSignatureData, getTags, getText, getTrackerService, isResolvedComment, setResolvedComment, setSignatureData

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_MODULE

static final String KEY_MODULE

See Also:

• Constant Field Values

KEY_IMPORTED_COMMENT

static final String KEY_IMPORTED_COMMENT

See Also:

• Constant Field Values

KEY_REFERRED_WORK_ITEM

static final String KEY_REFERRED_WORK_ITEM

Specifies to which work item this comment refers. Now it is used for external work items, but in future it can be also used for headings.

Since:

3.6.0

See Also:

• Constant Field Values

Method Details

getModule

IModule getModule()

getRootComment

@NotNull
IModuleComment getRootComment()

Specified by:

getRootComment in interface ICommentBase<IModuleComment>

getParentComment

@Nullable
IModuleComment getParentComment()

Specified by:

getParentComment in interface ICommentBase<IModuleComment>

createChildComment

@NotNull
IModuleComment createChildComment(Text text)

Description copied from interface: ICommentBase

Shortcut for createChildComment(text, true).

Specified by:

createChildComment in interface ICommentBase<IModuleComment>

See Also:

• ICommentBase.createChildComment(Text, boolean)

createChildComment

@NotNull
IModuleComment createChildComment(Text text,
 boolean reopen)

Description copied from interface: ICommentBase

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.

Specified by:

createChildComment in interface ICommentBase<IModuleComment>

Since:

3.7.1

getImportedComment

IModuleComment.IImportedCommentStruct getImportedComment()

createImportedComment

IModuleComment.IImportedCommentStruct createImportedComment(String author,
 String initials,
 Date created)

getReferredWorkItem

IWorkItem getReferredWorkItem()

see KEY_REFERRED_WORK_ITEM, can return null

Since:

3.6.0

setReferredWorkItem

void setReferredWorkItem(IWorkItem value)

see KEY_REFERRED_WORK_ITEM, can be called only on root comment

Throws:

IllegalStateException - if called for comment which is not root, exactly: if (getParentComment() != null)

Since:

3.6.0