com.starteam
Class ProcessItem

java.lang.Object
  com.starteam.ProcessItem

public final class ProcessItem
extends java.lang.Object

A process item in the context of a given target view.

Constructor Summary

ProcessItem(Item item, View target)
Constructs a process item in the context of a given target view.

ProcessItem(ViewMember vm)
Constructs a process item.

Method Summary

boolean	equals(java.lang.Object another) Compares this ProcessItem to another for equality
ChangePackageCollection	getChangePackages() Gets the ChangePackages associated with this process item, if any.
Item	getItem() Gets the underlying item.
View	getTargetView() Gets the target view.
int	hashCode() Return a hashCode for this process item.
ViewMemberCollection	resolve() Resolves this process item in the context of its target view.
ViewMemberCollection	resolveEx() A specialized implementation of ProcessItem.resolve() which prunes the resultant aggregated set of view members, eliminating duplicates at equal or lesser revisions.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProcessItem

public ProcessItem(ViewMember vm)

Constructs a process item. Assumes that the view member resides in the target view.

Parameters:

vm - The ViewMember to be treated as a process item. The view member is not necessarily a valid type for the target view.

ProcessItem

public ProcessItem(Item item,
                   View target)

Constructs a process item in the context of a given target view.

Parameters:

item - The item to be treated as a process item. The item is not necessarily a valid type for the target view.

target - The target view.

Method Detail

getItem

public Item getItem()

Gets the underlying item.

Returns:

The underlying item.

Throws:

java.lang.IllegalStateException - if this process item represents a change package.

getTargetView

public View getTargetView()

Gets the target view.

Returns:

The target view.

getChangePackages

public ChangePackageCollection getChangePackages()

Gets the ChangePackages associated with this process item, if any.

Returns:

ChangePackageCollection

resolve

public ViewMemberCollection resolve()

Resolves this process item in the context of its target view. A ProcessItem, in StarTeam terminology, is a ChangeRequest, Task or Requirement used as part of the file checkin & Change Management Process. Resolving a Process Item means following all its process links, direct old style links to view members, indirect old style links through 'Process' tasks to view members and (new style) traces through ChangePackages to view members (typically files and folders) This method will return all revisions of all attached items as they are discovered, including possibly duplicate item instances though at different revisions.

Returns:

The list of associated file and folder revisions representing changes associated with this process item in the target view.

resolveEx

public ViewMemberCollection resolveEx()

A specialized implementation of ProcessItem.resolve() which prunes the resultant aggregated set of view members, eliminating duplicates at equal or lesser revisions.

Returns:

a unique set of resolved view members at the highest appropriate revisions

See Also:

ProcessItem.resolve()

hashCode

public int hashCode()

Return a hashCode for this process item.

Overrides:

hashCode in class java.lang.Object

Returns:

a hashCode for this process item.

equals

public boolean equals(java.lang.Object another)

Compares this ProcessItem to another for equality

Overrides:

equals in class java.lang.Object

Parameters:

another - the ProcessItem to compare for equality

Returns:

true if the other ProcessItem is identical to this one