com.ibm.team.process.common

Class ProcessCommon

java.lang.Object

com.ibm.team.process.common.ProcessCommon

public class ProcessCommon
extends java.lang.Object

Since:

0.5

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALL_PROPERTIES Property collection identifier indicating all properties.
static int	MINIMAL_PROPERTIES Property collection identifier indicating a minimal set of required properties.
static java.lang.String	PLUGIN_ID Id of the bundle to which this class belongs.

Constructor Summary

Constructors

Constructor and Description
ProcessCommon()

Method Summary

Methods

Modifier and Type	Method and Description
static IOperationReport	cloneReport(IOperationReport toClone) Returns a copy of the given operation report.
static IItemChangeReport	createItemChangeReport() Creates a new item change report.
static IItemsResponse	createItemsResponse() Creates a new items response which can be used to send persistable items across the wire along with an operation report.
static IObjectsResponse	createObjectsResponse() Creates a new objects response which can be used to send data transfer objects (DTOs) across the wire along with an operation report.
static java.lang.String	getPropertyName(java.lang.Class clazz, java.lang.String propertyId) Returns the name of the property with the given property id for instances of IProjectArea, ITeamArea, IProcessArea, IProcessDefinition, IProcessDomainDefinition, IDevelopmentLine, IIteration, and IIterationType.
static boolean	requiredPropertiesSet(IProcessItem item, int propertyCollectionId) Returns whether the supplied process item has at least the properties set that are indicated by one of ALL_PROPERTIES or MINIMAL_PROPERTIES.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PLUGIN_ID

public static final java.lang.String PLUGIN_ID

Id of the bundle to which this class belongs.

See Also:

Constant Field Values

ALL_PROPERTIES

public static final int ALL_PROPERTIES

Property collection identifier indicating all properties.

See Also:

Constant Field Values

MINIMAL_PROPERTIES

public static final int MINIMAL_PROPERTIES

Property collection identifier indicating a minimal set of required properties.

See Also:

Constant Field Values

Constructor Detail

ProcessCommon

public ProcessCommon()

Method Detail

createItemsResponse

public static IItemsResponse createItemsResponse()

Creates a new items response which can be used to send persistable items across the wire along with an operation report.

Returns:

a new items response

createObjectsResponse

public static IObjectsResponse createObjectsResponse()

Creates a new objects response which can be used to send data transfer objects (DTOs) across the wire along with an operation report.

Returns:

a new objects response

createItemChangeReport

public static IItemChangeReport createItemChangeReport()

Creates a new item change report.

Returns:

a new item change report

cloneReport

public static IOperationReport cloneReport(IOperationReport toClone)

Returns a copy of the given operation report. This is necessary because of the way that EMF handles containment relationships. If report A contains a nested operation report X and report X is added to some other object (such as this OperationResponse), EMF will remove report X from report A in order to maintain a single container for report X.

By storing a copy of the report in response DTOs, we thus avoid breaking the nesting of reports.

Parameters:

report - the report to clone

Returns:

a copy of the given report

getPropertyName

public static java.lang.String getPropertyName(java.lang.Class clazz,
                               java.lang.String propertyId)

Returns the name of the property with the given property id for instances of IProjectArea, ITeamArea, IProcessArea, IProcessDefinition, IProcessDomainDefinition, IDevelopmentLine, IIteration, and IIterationType. If the given class is not one of these an IllegalArgumentException is thrown. The method returns null if no such property is defined.

Parameters:

clazz - the interface clazz

propertyId - the property id

Returns:

the name of the property with the given id, or null if no such property is defined

Throws:

java.lang.IllegalArgumentException - if the clazz is not of the supported types

requiredPropertiesSet

public static boolean requiredPropertiesSet(IProcessItem item,
                            int propertyCollectionId)

Returns whether the supplied process item has at least the properties set that are indicated by one of ALL_PROPERTIES or MINIMAL_PROPERTIES.

Parameters:

item - the item to check

propertyCollectionId - the property collection identifier to ensure that this item has set.

Returns:

whether the supplied item has all of the specified properties set