com.polarion.alm.tracker.model.IWorkItem

FIELDS

Modifiers and Type	Name	Description
String	PROTO
String	KEY_TITLE
String	KEY_DESCRIPTION
String	KEY_RESOLUTION
String	KEY_CATEGORIES
String	KEY_TIME_POINT
String	KEY_APPROVALS
String	KEY_LINKED_REVISIONS
String	KEY_LINKED_REVISIONS_DERIVED
String	KEY_ASSIGNEE
String	KEY_AUTHOR
String	KEY_COMMENTS
String	KEY_LINKED_WORK_ITEMS
String	KEY_LINKED_WORK_ITEMS_DERIVED
String	KEY_EXTERNALLY_LINKED_WORK_ITEMS
String	KEY_HYPERLINKS
String	KEY_PLANNING_CONSTRAINTS
String	KEY_SEVERITY
String	KEY_PRIORITY
String	KEY_WORK_RECORDS
String	KEY_LOCATION
String	KEY_LOCATION_TOKENIZED
String	KEY_LOCATION_TREE
String	KEY_MODULE
String	KEY_OUTLINE_NUMBER
String	KEY_DUE_DATE
String	KEY_INITIAL_ESTIMATE
String	KEY_TIME_SPENT
String	KEY_REMAINING_ESTIMATE
String	KEY_CREATED
String	KEY_UPDATED
String	KEY_PLANNED_START
String	KEY_PLANNED_END
String	KEY_PLANNED_IN
String	KEY_RESOLVED_ON
String	ENUM_ID_TYPE
String	ENUM_ID_STATUS
String	ENUM_ID_SEVERITY
String	ENUM_ID_PRIORITY
String	ENUM_ID_LINK_ROLE
String	TYPE_STRUCT_APPROVAL
String	TYPE_STRUCT_LINKED_WORK_ITEM
String	TYPE_STRUCT_LINKED_REVISION
String	TYPE_STRUCT_HYPERLINK
String	TYPE_STRUCT_PLANNING_CONSTRAINT
String	ATTACHMENT_IMG_PREFIX
String	ATTACHMENT_REVISION
String	ATTACHMENT_NAME
String[]	FIELD_ORDER
Set	DIFF_IGNORED_FIELDS

METHODS

Modifiers and Type	Name	Description
IModule	getModule()
IPObjectList	getExternalLinkingModules()	Returns the list of Documents that this Work Item is referenced in. The list of results is sorted by modification time. (The most recently modified is first.)
String	getOutlineNumber()
String	getTitle()
void	setTitle(String)
Text	getDescription()
void	setDescription(Text)
IResolutionOpt	getResolution()
void	setResolution(IResolutionOpt)
IPObjectList	getCategories()
boolean	addCategory(ICategory)
boolean	removeCategory(ICategory)
ITimePoint	getTimePoint()
void	setTimePoint(ITimePoint)
Collection	getApprovals()
void	removeApprovee(IUser)	Removes the user from the approvees collection. It has no effect if the user is not there.
void	addAprovee(IUser)	Adds the user to the approval collection with the default status. Has no effect, if the user is already there.
IApprovalBuilder	addApprovalFor(IUser)	Returns a builder that allows for the addition of a user to the collection of approvals, with a status selected by {@link IApprovalBuilder#withStatus(String)} .
void	setApprovalStatus(IUser,IApprovalStatusOpt)	Sets the approval status for the given user. The user is added if they are not yet in the approvees collection.
IPObjectList<IRevision>	getLinkedRevisions()
IPObjectList<IRevision>	getLinkedRevisionsDirect()
IPObjectList<IRevision>	getLinkedRevisionsDerived()
boolean	addLinkedRevision(String,String)	Adds the given revision to revisions that are directly linked. Does nothing if the revision is already in the linked revisions set.
boolean	removeLinkedRevision(String,String)	Removes the given revision from the link set. Does nothing if the revision is not in the set.
boolean	addLinkedRevision(IRevision)	Adds the revision to revisions that are directly linked. Does nothing if the revision is already in the linked revisions set.
boolean	removeLinkedRevision(IRevision)	Removes the given revision from the link set. Does nothing if the revision is not in the set.
IPObjectList	getAssignees()
boolean	addAssignee(IUser)	Adds a user to the list of assignees.
boolean	removeAssignee(IUser)	Removes a user from the list of assignees.
IPObjectList	getAllowedAssignees()	Allowed assignees. Allowed assignee is a user with the global "assignable" role or the context "project_assignable" role .
IPObjectList	getAllowedApprovers()	Allowed approvers. Allowed approver is a user with the global "approver" role or the context "project_approver" role .
void	doAutoAssign()	Performs the auto-assignment of this item, based on the relevant configuration. The changes are not automatically saved.
void	doAutoSuspect()	Performs an autosuspect of this item.
void	doSuspectDerivedItems()	Set suspect=true to links from derived items.
IUser	getAuthor()	Returns this Work Item author. The author field can not be changed, therefore there is no set method for this field.
IPObjectList<IComment>	getComments()	Shortcut for `getComments(true)`.
IPObjectList<IComment>	getComments(boolean)	Optionally also includes resolved comments. Sorts comments by creation time.
IPObjectList<IComment>	getComments(boolean,ICommentBase.SortBy)	Optionally also includes resolved comments. Sorts comments according to a parameter.
IPObjectList<IComment>	getRootComments()	Shortcut for `getRootComments(true)`.
IPObjectList<IComment>	getRootComments(boolean)	Returns the root comments of this Work Item. Optionally includes resolved comments.
IComment	createComment(Text)	Creates a (temporary) comment object, that can be manipulated by the client. However, the comment is not persisted until it's explicitly saved. The fields `workItem, project, author, date` are pre-filled with their values.
IComment	createComment(Text,String,List)	Creates a (temporary) comment object, that can be manipulated by the client. However, the comment is not persisted until it's explicitly saved. The fields `workItem, project, author, date` are pre-filled with their values.
IWorkRecord	createWorkRecord(IUser,DateOnly,DurationTime)	Creates a (temporary) work record object, that can be manipulated by the client. However, the work record is not persisted until it's explicitly saved. The fields `workItem` and `project` are pre-filled.
IWorkRecord	createWorkRecord(IUser,DateOnly,IWorkRecordTypeOpt,DurationTime,String)	Creates a (temporary) work record object, that can be manipulated by the client. However, the work record is not persisted until it's explicitly saved. The fields `workItem` and `project` are pre-filled.
void	deleteWorkRecord(IWorkRecord)	Removes and deletes the work record from this Work Item.
IAttachment	getAttachmentByFileName(String)
IPObjectList<IAttachmentBase>	getAttachmentsContainedByDescription()	Returns the attachments of this Work Item that are referenced by the description; this includes images and diagram data attachments.
IPObjectList<IAttachmentBase>	getAttachmentsContainedByText(Text,boolean)	Returns the attachments of this Work Item that are referenced by a certain field; this includes images and diagram data attachments.
IPObjectList<IAttachmentBase>	getAllAttachmentsContainedByDescription()	Returns all attachments that are referenced by the description; this includes images and diagram data attachments. These attachments can be owned by the containing document.
Collection	getLinkedWorkItemsStructsDirect()	Returns the collection of {@link ILinkedWorkItemStruct} structures contained in this item.
Collection	getLinkedWorkItemsStructsBack()	Returns the collection of {@link ILinkedWorkItemStruct} structures that reference this item. The result is obtained by querying and involves resolving all items that link to this item.
List	getLinkedWorkItemsStructsDirect(String)	The same as {@link #getLinkedWorkItemsStructsDirect()} but with possibility to have the links sorted by a Work Item sort string. If a sort string is specified, the result is obtained by querying.
List	getLinkedWorkItemsStructsBack(String)	The same as {@link #getLinkedWorkItemsStructsBack()} but with possibility to have the links sorted by Work Item a sort string.
List	getExternallyLinkedWorkItemsStructs()	All external links. Returns data even if {@link ITrackerService#isExternalLinkingEnabled(com.polarion.subterra.base.data.identification.IContextId)} is `false`.
List	getExternallyLinkedWorkItemsStructsDirect()	All direct external links. Returns data even if {@link ITrackerService#isExternalLinkingEnabled(com.polarion.subterra.base.data.identification.IContextId)} is `false`.
boolean	isAutoSuspectOn()	Returns true, if modifications of this item should, by default, result in setting the suspect flag. This is a hint for the UI, that renders the default value.
boolean	hasSuspectLinks()
boolean	addLinkedItem(IWorkItem,ILinkRoleOpt,String,boolean)	Adds the link. If the link already exists, it will NOT add another one. Links are the same, when target item and link role are equal. The link is also not created when the given item is same as this item.
boolean	removeLinkedItem(IWorkItem,IEnumOption)	Removes the link. Does nothing, if there is no such link.
IPObjectList<IWorkItem>	getLinkedWorkItems()	Returns all Work Items linked with and that link this Work Item. The returned collection is a union of collections returned from the {@link #getLinkedWorkItemsDirect()} and {@link #getLinkedWorkItemsBack()} methods.
IPObjectList<IWorkItem>	getLinkedWorkItemsDirect()
IPObjectList<IWorkItem>	getLinkedWorkItemsBack()
boolean	traverseLinkedWorkitems(Set,Set,Set,ITerminalCondition)	Traverses, depth first, the tree of items linked (both backward and forward) with this item then adds all touched items to the `treeLinked` return parameter and terminates either by traversing all of them or on a given condition.
Collection	getHyperlinks()
boolean	addHyperlink(String,IEnumOption)
boolean	removeHyperlink(String)
ITypedList	getPlanningConstraints()
boolean	addPlanningConstraint(Date,IPlanningConstraintOpt)	Adds the new planning constraint. Does nothing if such a constraint already exists or would conflict with another one.
boolean	removePlanningConstraint(Date,IPlanningConstraintOpt)	Removes the given planning constraint. Does nothing, if no such constraint exists.
Date	getPlaningConstraintDate(String)	Returns the Date of a planning constraint.
DateOnly	getDueDate()	Returns the due date of this Work Item.
void	setDueDate(DateOnly)	Sets the due data for this Work Item.
DurationTime	getInitialEstimate()	Returns the initial estimate of this Work Item.
void	setInitialEstimate(DurationTime)	Sets the initial estimate for this Work Item.
DurationTime	getTimeSpent()
void	setTimeSpent(DurationTime)	Sets The time spent on this Work Item.
DurationTime	getRemainingEstimate()
void	setRemainingEstimate(DurationTime)	Sets the new estimate to complete this Work Item
Date	getCreated()
Date	getUpdated()
Date	getPlannedStart()
void	setPlannedStart(Date)	Sets the date of the planned start of an activity for this Work Item.
Date	getPlannedEnd()
void	setPlannedEnd(Date)	Sets the date of the planned end of an activity for this Work Item.
List	getPlannedIn()
Date	getResolvedOn()
boolean	isVotingEnabled()	Shortcut for {@link com.polarion.alm.tracker.IVotingManager#isVotingEnabled(IWorkItem)}
int	getVotesCount()	Shortcut for {@link com.polarion.alm.tracker.IVotingManager#getVotesCount(IWorkItem)}
IPObjectList	getVotes()	Shortcut for {@link com.polarion.alm.tracker.IVotingManager#getVotes(IWorkItem)}
IPObjectList	getWatchingUsers()
IPriorityOpt	getPriority()
void	setPriority(IPriorityOpt)
IPriorityOpt	createPriorityOpt(float)	Creates a new Priority Option for the given value. Just a short form of `getProject().getPriorityEnum().wrapOption(value)`.
IPriorityOpt	getClosestStandardOpt(IPriorityOpt)	Returns the closest standard option for the given option. The shortcut for `this.getProject().getPriorityEnum().getClosestStandardOpt(option.getFloat())`.
ISeverityOpt	getSeverity()
void	setSeverity(ISeverityOpt)
IPObjectList<IWorkRecord>	getWorkRecords()	Returns the list of work records for this Work Item.
ILocation	getLocation()	Returns the location of this Work Item in the repository.
void	delete()	Deletes this Work Item (including comments, work records and attachments) and removes all its files from the repository.
String	getLocalizedTitle(String)	Returns the localized title or the normal title if the localized title is not defined or empty.
Text	getLocalizedDescription(String)	Returns the localized description or the normal description if the localized description is not defined or empty.
void	setLocalizedTitle(String,String)	Sets the localized title.
void	setLocalizedDescription(String,Text)	Sets the localized description.
ITestCase	getTestCase()	Returns The test case specific view of this Work Item.
default, String	getLabel()	Return a string with the format 'ID - Title' or only the ID if the Title is null or empty.

Back to Index