com.ibm.team.process.common

Interface IDescription

public interface IDescription

A description of an element.

Since:

0.5

Method Summary

Methods

Modifier and Type	Method and Description
IContent	getDetails() Returns the detailed description or null if there is no detailed description in addition to the summary.
java.lang.String	getSummary() Returns the summary of the description or null if no summary has been set.
void	setDetails(IContent details) Sets the detailed description or null.
void	setSummary(java.lang.String summary) Sets the summary for this element.

Method Detail

getSummary

java.lang.String getSummary()

Returns the summary of the description or null if no summary has been set.

In order for this item to be saved to the repository this field must have a non-null value, so it is safe to assume that this method will not return null if it is an immutable copy fetched from the repository. It is possible for an incomplete/invalid working copy, however, to return null.

Returns:

the summary of the description

setSummary

void setSummary(java.lang.String summary)

Sets the summary for this element.

Parameters:

summary - the new summary for the element

getDetails

IContent getDetails()

Returns the detailed description or null if there is no detailed description in addition to the summary.

Returns:

the detailed description or null

setDetails

void setDetails(IContent details)

Sets the detailed description or null.

Parameters:

details - the new detailed description or null