com.ibm.team.workitem.common.model

Interface IWorkItem

All Superinterfaces:

IAuditable, IAuditableHandle, IItem, IItemHandle, IManagedItem, IManagedItemHandle, IProjectScoped, IWorkItemHandle

public interface IWorkItem
extends IWorkItemHandle, IAuditable, IProjectScoped

A work item represents a piece of work in a certain state (like new, in progress, done). Various built-in attributes are provided and additional custom attributes can be added.

Since:

0.5

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	APPROVAL_DESCRIPTORS_PROPERTY The approval descriptors property, see getApprovals().
static java.lang.String	APPROVALS_PROPERTY The approvals property, see getApprovals().
static java.lang.String	ARCHIVED_PROPERTY The archived property, not surfaced yet }.
static java.lang.String	CATEGORY_PROPERTY The 'filed against' property, see getCategory().
static java.lang.String	COMMENTS_PROPERTY The comments property, see getComments().
static java.lang.String	CREATION_DATE_PROPERTY The creation date property, see getCreationDate().
static java.lang.String	CREATOR_PROPERTY The 'created by' property, see getCreator().
static java.util.Collection<java.lang.String>	CUSTOM_ATTRIBUTE_PROPERTIES
static java.lang.String	CUSTOM_ATTRIBUTES_PROPERTY The custom attributes property, see getCustomAttributes().
static ItemProfile<IWorkItem>	DEFAULT_PROFILE
static java.lang.String	DESCRIPTION_PROPERTY The description property, see getHTMLDescription().
static java.lang.String	DUE_DATE_PROPERTY The due date property, see getDueDate().
static java.lang.String	DURATION_PROPERTY The estimate property, see getDuration().
static java.lang.String	ESIGNATURE_RECORD_PROPERTY The ESignatureRecord property, see getESignatureRecords().
static java.lang.String	FOUND_IN_PROPERTY The 'found in' property.
static ItemProfile<IWorkItem>	FULL_PROFILE The full item profile.
static ItemProfile<IWorkItem>	ID_PROFILE
static java.lang.String	ID_PROPERTY The id property, see getId().
static IItemType	ITEM_TYPE The Work Item item type.
static ItemProfile<IWorkItem>	LARGE_PROFILE
static ItemProfile<IWorkItem>	MEDIUM_PROFILE
static java.lang.String	OWNER_PROPERTY The owner property, see getOwner().
static java.lang.String	PRIORITY_PROPERTY The priority property, see getPriority().
static java.lang.String	PROJECT_AREA_PROPERTY The project area property, see getProjectArea().
static java.lang.String	RESOLUTION_DATE_PROPERTY The resolution date property, see getResolutionDate().
static java.lang.String	RESOLUTION_PROPERTY The resolution property, see getResolution2().
static java.lang.String	RESOLVER_PROPERTY The 'resolved by' property, see getState2().
static java.lang.String	SEVERITY_PROPERTY The severity property, see getSeverity().
static ItemProfile<IWorkItem>	SMALL_PROFILE
static ItemProfile<IWorkItem>	STATE_PROFILE
static java.lang.String	STATE_PROPERTY The state property, see getState2().
static java.lang.String	STATE_TRANSITIONS_PROPERTY The state transitions property, see getStateTransitions().
static java.lang.String	SUBSCRIPTIONS_PROPERTY The subscribers property, see getSubscriptions().
static java.lang.String	SUMMARY_PROPERTY The summary property, see getHTMLSummary().
static java.lang.String	TAGS_PROPERTY The tags property, see getTags().
static java.lang.String	TARGET_PROPERTY The 'planned for' property, see getTarget().
static java.lang.String	TYPE_PROPERTY The type property, see getWorkItemType().
static java.lang.String	UNASSIGNED_FOUND_IN_NAME 'Found in' name when the value is null.
static java.lang.String	UNASSIGNED_TARGET_NAME 'Planned for' name when the value is null.
static java.lang.String	WORKFLOW_SURROGATE_PROPERTY The workflow surrogate property.
static java.util.Collection<java.lang.String>	WORKITEM_CUSTOM_ATTRIBUTE_PROPERTIES The properties needed to work with custom attributes.

Fields inherited from interface com.ibm.team.repository.common.IAuditable

MERGE_PREDECESSOR_STATE_PROPERTY, PREDECESSOR_STATE_PROPERTY

Fields inherited from interface com.ibm.team.repository.common.IItem

CONTEXT_ID_PROPERTY, ITEM_ID_PROPERTY, MAX_LARGE_STRING_BYTES, MAX_MEDIUM_STRING_BYTES, MAX_SMALL_STRING_BYTES, MODIFIED_BY_PROPERTY, MODIFIED_PROPERTY, STATE_ID_PROPERTY

Method Summary

Methods

Modifier and Type	Method and Description
void	addCustomAttribute(IAttribute attribute) Adds the given custom attribute to the work item.
IApprovals	getApprovals() Returns the approvals
ICategoryHandle	getCategory() Returns the 'filed against' category.
IComments	getComments() Returns the comments.
java.sql.Timestamp	getCreationDate() Returns the creation date.
IContributorHandle	getCreator() Returns the creator.
java.util.List<IAttributeHandle>	getCustomAttributes() Returns the list of custom attributes.
java.sql.Timestamp	getDueDate() Returns the due date.
long	getDuration() Returns the estimate in milliseconds.
java.util.List	getESignatureRecords() Returns the ESignature records associated with this work item
com.ibm.team.foundation.common.text.XMLString	getHTMLDescription() Returns the description.
com.ibm.team.foundation.common.text.XMLString	getHTMLSummary() Returns the summary.
int	getId() Returns the numeric id.
IContributorHandle	getOwner() Returns the owner.
Identifier<IPriority>	getPriority() Returns the priority.
IProjectAreaHandle	getProjectArea() Returns the project area.
Identifier<IResolution>	getResolution2() Returns the resolution.
java.sql.Timestamp	getResolutionDate() Returns the resolution date.
IContributorHandle	getResolver() Returns the resolver.
Identifier<ISeverity>	getSeverity() Returns the severity.
Identifier<IState>	getState2() Returns the workflow state.
IStateTransitions	getStateTransitions() Returns the state transitions this work item went through
ISubscriptions	getSubscriptions() Returns the subscribers.
java.lang.String	getTags() Deprecated. Use getTags2() or getValue(IAttribute)
java.util.List<java.lang.String>	getTags2() Returns the list of tags
IIterationHandle	getTarget() Returns the 'planned for' iteration.
java.lang.Object	getValue(IAttribute attribute) Returns the value of the given attribute.
java.lang.String	getWorkItemType() Returns the work item type.
boolean	hasAttribute(IAttribute attribute) Returns true iff the work item has the given attribute.
boolean	hasBuiltInAttribute(IAttribute attribute)
boolean	hasCustomAttribute(IAttributeHandle attribute)
boolean	isAttributeSet(IAttribute attribute) Returns true iff the work item has the given attribute and the attribute value is part of the work item's item profile.
void	removeCustomAttribute(IAttribute attribute) Removes the given custom attribute from the work item.
void	setAttributeChangedNotifier(com.ibm.team.workitem.common.internal.model.AttributeChangedNotifier notifier)
void	setCategory(ICategoryHandle value) Sets the 'filed against' category.
void	setCreationDate(java.sql.Timestamp value) Internal
void	setCreator(IContributorHandle value) Internal
void	setDueDate(java.sql.Timestamp value) Sets the due date.
void	setDuration(long duration) Sets the estimate in milliseconds.
void	setHTMLDescription(com.ibm.team.foundation.common.text.XMLString xmlString) Sets the description to the given xml string.
void	setHTMLSummary(com.ibm.team.foundation.common.text.XMLString xmlString) Sets the summary to the given XML string.
void	setOwner(IContributorHandle value) Sets the owner.
void	setPriority(Identifier<IPriority> value) Sets the priority to the given identifier.
void	setResolution2(Identifier<IResolution> value) Sets the resolution.
void	setSeverity(Identifier<ISeverity> value) Sets the severity to the given identifier.
void	setState2(Identifier<IState> value) Deprecated.
void	setTags(java.lang.String value) Deprecated. Use setTags2(List) or setValue(IAttribute, Object)
void	setTags2(java.util.List<java.lang.String> tags) Sets the tags
void	setTarget(IIterationHandle value) Sets the 'planned for' iteration.
void	setValue(IAttribute attribute, java.lang.Object value) Sets the value of the given attribute.
void	setWorkItemType(java.lang.String value) Deprecated. use IWorkItemCommon.changeWorkItemType(IWorkItem, IWorkItemType, org.eclipse.core.runtime.IProgressMonitor) instead

Methods inherited from interface com.ibm.team.repository.common.IAuditable

getMergePredecessorState, getPredecessorState

Methods inherited from interface com.ibm.team.repository.common.IManagedItem

isNewItem

Methods inherited from interface com.ibm.team.repository.common.IItem

getContextId, getItemHandle, getModifiedBy, getRedactedCopy, getRequestedModified, getRequestedStateId, getStateHandle, getWorkingCopy, hasHistory, isComplete, isPropertySet, isRedactedCopy, isWorkingCopy, modified, setContextId, setRequestedModified, setRequestedStateId

Methods inherited from interface com.ibm.team.repository.common.IItemHandle

equals, getAdapter, getFullState, getItemId, getItemType, getOrigin, getStateId, hasFullState, hasStateId, isAuditable, isConfigurationAware, isImmutable, isSimple, isUnmanaged, makeImmutable, protect, sameItemId, sameStateId, size

Field Detail

ITEM_TYPE

static final IItemType ITEM_TYPE

The Work Item item type.

ID_PROPERTY

static final java.lang.String ID_PROPERTY

The id property, see getId().

TYPE_PROPERTY

static final java.lang.String TYPE_PROPERTY

The type property, see getWorkItemType().

PROJECT_AREA_PROPERTY

static final java.lang.String PROJECT_AREA_PROPERTY

The project area property, see getProjectArea().

SUMMARY_PROPERTY

static final java.lang.String SUMMARY_PROPERTY

The summary property, see getHTMLSummary().

CUSTOM_ATTRIBUTES_PROPERTY

static final java.lang.String CUSTOM_ATTRIBUTES_PROPERTY

The custom attributes property, see getCustomAttributes().

STATE_PROPERTY

static final java.lang.String STATE_PROPERTY

The state property, see getState2().

CREATOR_PROPERTY

static final java.lang.String CREATOR_PROPERTY

The 'created by' property, see getCreator().

OWNER_PROPERTY

static final java.lang.String OWNER_PROPERTY

The owner property, see getOwner().

SEVERITY_PROPERTY

static final java.lang.String SEVERITY_PROPERTY

The severity property, see getSeverity().

PRIORITY_PROPERTY

static final java.lang.String PRIORITY_PROPERTY

The priority property, see getPriority().

FOUND_IN_PROPERTY

static final java.lang.String FOUND_IN_PROPERTY

The 'found in' property.

DESCRIPTION_PROPERTY

static final java.lang.String DESCRIPTION_PROPERTY

The description property, see getHTMLDescription().

WORKFLOW_SURROGATE_PROPERTY

static final java.lang.String WORKFLOW_SURROGATE_PROPERTY

The workflow surrogate property.

CREATION_DATE_PROPERTY

static final java.lang.String CREATION_DATE_PROPERTY

The creation date property, see getCreationDate().

RESOLUTION_PROPERTY

static final java.lang.String RESOLUTION_PROPERTY

The resolution property, see getResolution2().

DUE_DATE_PROPERTY

static final java.lang.String DUE_DATE_PROPERTY

The due date property, see getDueDate().

DURATION_PROPERTY

static final java.lang.String DURATION_PROPERTY

The estimate property, see getDuration().

CATEGORY_PROPERTY

static final java.lang.String CATEGORY_PROPERTY

The 'filed against' property, see getCategory().

COMMENTS_PROPERTY

static final java.lang.String COMMENTS_PROPERTY

The comments property, see getComments().

TARGET_PROPERTY

static final java.lang.String TARGET_PROPERTY

The 'planned for' property, see getTarget().

RESOLVER_PROPERTY

static final java.lang.String RESOLVER_PROPERTY

The 'resolved by' property, see getState2().

RESOLUTION_DATE_PROPERTY

static final java.lang.String RESOLUTION_DATE_PROPERTY

The resolution date property, see getResolutionDate().

TAGS_PROPERTY

static final java.lang.String TAGS_PROPERTY

The tags property, see getTags().

SUBSCRIPTIONS_PROPERTY

static final java.lang.String SUBSCRIPTIONS_PROPERTY

The subscribers property, see getSubscriptions().

APPROVAL_DESCRIPTORS_PROPERTY

static final java.lang.String APPROVAL_DESCRIPTORS_PROPERTY

The approval descriptors property, see getApprovals().

APPROVALS_PROPERTY

static final java.lang.String APPROVALS_PROPERTY

The approvals property, see getApprovals().

ARCHIVED_PROPERTY

static final java.lang.String ARCHIVED_PROPERTY

The archived property, not surfaced yet }.

STATE_TRANSITIONS_PROPERTY

static final java.lang.String STATE_TRANSITIONS_PROPERTY

The state transitions property, see getStateTransitions().

ESIGNATURE_RECORD_PROPERTY

static final java.lang.String ESIGNATURE_RECORD_PROPERTY

The ESignatureRecord property, see getESignatureRecords().

WORKITEM_CUSTOM_ATTRIBUTE_PROPERTIES

static final java.util.Collection<java.lang.String> WORKITEM_CUSTOM_ATTRIBUTE_PROPERTIES

The properties needed to work with custom attributes.

CUSTOM_ATTRIBUTE_PROPERTIES

static final java.util.Collection<java.lang.String> CUSTOM_ATTRIBUTE_PROPERTIES

ID_PROFILE

static final ItemProfile<IWorkItem> ID_PROFILE

SMALL_PROFILE

static final ItemProfile<IWorkItem> SMALL_PROFILE

DEFAULT_PROFILE

static final ItemProfile<IWorkItem> DEFAULT_PROFILE

MEDIUM_PROFILE

static final ItemProfile<IWorkItem> MEDIUM_PROFILE

LARGE_PROFILE

static final ItemProfile<IWorkItem> LARGE_PROFILE

STATE_PROFILE

static final ItemProfile<IWorkItem> STATE_PROFILE

FULL_PROFILE

static final ItemProfile<IWorkItem> FULL_PROFILE

The full item profile.

UNASSIGNED_TARGET_NAME

static final java.lang.String UNASSIGNED_TARGET_NAME

'Planned for' name when the value is null.

UNASSIGNED_FOUND_IN_NAME

static final java.lang.String UNASSIGNED_FOUND_IN_NAME

'Found in' name when the value is null.

Method Detail

getValue

java.lang.Object getValue(IAttribute attribute)

Returns the value of the given attribute. The work item must have the attribute.

Parameters:

attribute - the attribute

Returns:

the attribute value

See Also:

hasAttribute(IAttribute)

setValue

void setValue(IAttribute attribute,
            java.lang.Object value)

Sets the value of the given attribute. The work item must have the attribute.

Parameters:

attribute - the attribute

value - the value

See Also:

hasAttribute(IAttribute), addCustomAttribute(IAttribute), IWorkItemCommon.findAttribute(IProjectAreaHandle, String, org.eclipse.core.runtime.IProgressMonitor), IWorkItemCommon.createNewAttribute(IProjectAreaHandle, String, String, String, org.eclipse.core.runtime.IProgressMonitor)

isAttributeSet

boolean isAttributeSet(IAttribute attribute)

Returns true iff the work item has the given attribute and the attribute value is part of the work item's item profile.

Parameters:

attribute - the attribute

Returns:

true iff the attribute is set

See Also:

hasAttribute(IAttribute), ItemProfile

hasAttribute

boolean hasAttribute(IAttribute attribute)

Returns true iff the work item has the given attribute.

Parameters:

attribute - the attribute

Returns:

true iff the work item has the given attribute

hasBuiltInAttribute

boolean hasBuiltInAttribute(IAttribute attribute)

hasCustomAttribute

boolean hasCustomAttribute(IAttributeHandle attribute)

addCustomAttribute

void addCustomAttribute(IAttribute attribute)

Adds the given custom attribute to the work item. The work item must not have the attribute already and the attribute must have a supported type.

Clients should initialize the attribute to either a specific value or its default value.

Parameters:

attribute - the custom attribute

See Also:

hasAttribute(IAttribute), AttributeTypes.isSupportedCustomAttributeType(String), setValue(IAttribute, Object), IAttribute.getDefaultValue(com.ibm.team.workitem.common.IAuditableCommon, IWorkItem, org.eclipse.core.runtime.IProgressMonitor)

removeCustomAttribute

void removeCustomAttribute(IAttribute attribute)

Removes the given custom attribute from the work item.

Parameters:

attribute - the custom attribute

setAttributeChangedNotifier

void setAttributeChangedNotifier(com.ibm.team.workitem.common.internal.model.AttributeChangedNotifier notifier)

getWorkItemType

java.lang.String getWorkItemType()

Returns the work item type.

Returns:

the work item type

See Also:

IWorkItemCommon.findWorkItemType(IProjectAreaHandle, String, org.eclipse.core.runtime.IProgressMonitor), IWorkItemType

getId

int getId()

Returns the numeric id.

Returns:

the numeric id or -1 if not initialized

See Also:

IWorkItemCommon.findWorkItemById(int, ItemProfile, org.eclipse.core.runtime.IProgressMonitor)

getProjectArea

IProjectAreaHandle getProjectArea()

Returns the project area. The project area is initialized during creation and given by the type the work item is created from.

Specified by:

getProjectArea in interface IProjectScoped

Returns:

the project area

See Also:

IWorkItemType

getState2

Identifier<IState> getState2()

Returns the workflow state. The state is managed by the work item component.

Returns:

the state or null if not initialized

See Also:

IWorkflowInfo.getStateName(Identifier), IWorkflowInfo.getStateIconName(Identifier)

setState2

@Deprecated
void setState2(Identifier<IState> value)

Deprecated.

Do not use this method. The correct way is to set the workflow action on save.

See Also:

com.ibm.team.workitem.service.IWorkItemServer#saveWorkItem2(IWorkItem, IWorkItemReferences, String)}, com.ibm.team.workitem.client.WorkItemWorkingCopy#setWorkflowAction(String)}, com.ibm.team.workitem.client.WorkItemWorkingCopy#save(IProgressMonitor)}, com.ibm.team.workitem.common.workflow.IWorkflowInfo#getActionIds(Identifier)}

getResolution2

Identifier<IResolution> getResolution2()

Returns the resolution.

Returns:

the resolution or null

See Also:

IWorkflowInfo.getResolutionName(Identifier), IWorkflowInfo.getResolutionIconName(Identifier)

setResolution2

void setResolution2(Identifier<IResolution> value)

Sets the resolution.

Parameters:

value - the new resolution or null

See Also:

IWorkflowInfo.getResolutionIds(Identifier)

getResolver

IContributorHandle getResolver()

Returns the resolver. The resolver is managed by the work item component.

Returns:

the resolver or null

getResolutionDate

java.sql.Timestamp getResolutionDate()

Returns the resolution date. The resolution date is managed by the work item component.

Returns:

the resolution date or null

getHTMLSummary

com.ibm.team.foundation.common.text.XMLString getHTMLSummary()

Returns the summary.

Returns:

the summary

setHTMLSummary

void setHTMLSummary(com.ibm.team.foundation.common.text.XMLString xmlString)

Sets the summary to the given XML string.

Parameters:

xmlString - the new summary

getSeverity

Identifier<ISeverity> getSeverity()

Returns the severity.

Returns:

the severity or null

See Also:

IWorkItemCommon.resolveEnumeration(IAttributeHandle, org.eclipse.core.runtime.IProgressMonitor), IEnumeration.findEnumerationLiteral(Identifier)

setSeverity

void setSeverity(Identifier<ISeverity> value)

Sets the severity to the given identifier.

Parameters:

value - the new severity

See Also:

IWorkItemCommon.resolveEnumeration(IAttributeHandle, org.eclipse.core.runtime.IProgressMonitor), IEnumeration.getEnumerationLiterals()

getCreationDate

java.sql.Timestamp getCreationDate()

Returns the creation date. The creation date is managed by the work item component.

Returns:

the creation date or null if not initialized

setCreationDate

void setCreationDate(java.sql.Timestamp value)

Internal

getCreator

IContributorHandle getCreator()

Returns the creator. The creator is managed by the work item component.

Returns:

the creator or null if not initialized

setCreator

void setCreator(IContributorHandle value)

Internal

getPriority

Identifier<IPriority> getPriority()

Returns the priority.

Returns:

the priority or null

See Also:

IWorkItemCommon.resolveEnumeration(IAttributeHandle, org.eclipse.core.runtime.IProgressMonitor), IEnumeration.findEnumerationLiteral(Identifier)

setPriority

void setPriority(Identifier<IPriority> value)

Sets the priority to the given identifier.

Parameters:

value - the new priority

See Also:

IWorkItemCommon.resolveEnumeration(IAttributeHandle, org.eclipse.core.runtime.IProgressMonitor), IEnumeration.getEnumerationLiterals()

getDueDate

java.sql.Timestamp getDueDate()

Returns the due date.

Returns:

the due date or null

setDueDate

void setDueDate(java.sql.Timestamp value)

Sets the due date.

Parameters:

value - the new due date or null

getDuration

long getDuration()

Returns the estimate in milliseconds.

Returns:

the estimate or -1 if not set

See Also:

Duration

setDuration

void setDuration(long duration)

Sets the estimate in milliseconds.

Parameters:

duration - the new estimate or -1 to clear

See Also:

Duration

getOwner

IContributorHandle getOwner()

Returns the owner.

Returns:

the owner or null

setOwner

void setOwner(IContributorHandle value)

Sets the owner.

Parameters:

value - the new owner or null

getHTMLDescription

com.ibm.team.foundation.common.text.XMLString getHTMLDescription()

Returns the description.

Returns:

the description

setHTMLDescription

void setHTMLDescription(com.ibm.team.foundation.common.text.XMLString xmlString)

Sets the description to the given xml string.

Parameters:

xmlString - the new description

getComments

IComments getComments()

Returns the comments.

Returns:

the comments

getCategory

ICategoryHandle getCategory()

Returns the 'filed against' category.

Returns:

the 'filed against' category

See Also:

IWorkItemCommon.resolveHierarchicalName(ICategoryHandle, org.eclipse.core.runtime.IProgressMonitor)

setCategory

void setCategory(ICategoryHandle value)

Sets the 'filed against' category.

Parameters:

value - the new 'filed against' category

See Also:

IWorkItemCommon.findCategories(IProjectAreaHandle, ItemProfile, org.eclipse.core.runtime.IProgressMonitor)

getCustomAttributes

java.util.List<IAttributeHandle> getCustomAttributes()

Returns the list of custom attributes.

NOTE: Clients must not change this list directly.

Returns:

the custom attributes

See Also:

addCustomAttribute(IAttribute), removeCustomAttribute(IAttribute)

getSubscriptions

ISubscriptions getSubscriptions()

Returns the subscribers.

Returns:

the subscribers

getApprovals

IApprovals getApprovals()

Returns the approvals

Returns:

the approvals

getStateTransitions

IStateTransitions getStateTransitions()

Returns the state transitions this work item went through

Returns:

the state transitions

Since:

3.0

getESignatureRecords

java.util.List getESignatureRecords()

Returns the ESignature records associated with this work item

Returns:

the esignature records

getTarget

IIterationHandle getTarget()

Returns the 'planned for' iteration.

Returns:

the 'planned for' iteration

setTarget

void setTarget(IIterationHandle value)

Sets the 'planned for' iteration.

Parameters:

value - the new 'planned for' iteration

See Also:

IDevelopmentLine.getIterations(), IIteration.getChildren()

getTags

@Deprecated
java.lang.String getTags()

Deprecated. Use getTags2() or getValue(IAttribute)

Returns the tags.

Returns:

the tags

See Also:

TagsAttributeType.parseTags(String)

getTags2

java.util.List<java.lang.String> getTags2()

Returns the list of tags

Returns:

the tags

Since:

0.7

setTags

@Deprecated
void setTags(java.lang.String value)

Deprecated. Use setTags2(List) or setValue(IAttribute, Object)

Sets the tags.

Parameters:

value - the new tags

setTags2

void setTags2(java.util.List<java.lang.String> tags)

Sets the tags

Parameters:

tags -

Since:

0.7

setWorkItemType

@Deprecated
void setWorkItemType(java.lang.String value)

Deprecated. use IWorkItemCommon.changeWorkItemType(IWorkItem, IWorkItemType, org.eclipse.core.runtime.IProgressMonitor) instead