com.ibm.team.process.common

Interface ITeamAreaHierarchy

public interface ITeamAreaHierarchy

Defines a hierarchy of team areas.

Since:

0.5

Method Summary

Methods

Modifier and Type	Method and Description
void	addChild(ITeamAreaHandle parent, ITeamAreaHandle child) Adds a given team area as a child to another given team area.
void	addRoot(ITeamAreaHandle root, IDevelopmentLineHandle developmentLine) Adds the given team area as a root to this hierarchy in the given development line.
java.util.Set	getChildren(ITeamAreaHandle parent) Returns the children for the given team area.
IDevelopmentLineHandle	getDevelopmentLine(ITeamAreaHandle teamAreaHandle) Returns the development line to which the given team area belongs in this hierarchy or null if the team area does not belong to a development line.
ITeamAreaHandle	getParent(ITeamAreaHandle child) Returns the parent of the given team area or null if the team area is a root.
IDevelopmentLineHandle	getRawDevelopmentLine(ITeamAreaHandle teamAreaHandle) Returns the development line to which the given team area belongs in this hierarchy or null if the team area does not belong to a development line.
java.util.Set	getRoots() Returns all root team areas.
java.util.List	getTeamAreas() Returns a list of all team areas contained in this team area hierarchy.
void	promoteToRoot(ITeamAreaHandle root) Promotes the given team area to be a root of this hierarchy within its current development line.
void	remove(ITeamAreaHandle teamArea) Removes the given team area from the hierarchy.
void	reparent(ITeamAreaHandle newParent, ITeamAreaHandle child) Adds a given team area as a child to another given team area when the child team area may already have a parent team area.
void	setDevelopmentLine(ITeamAreaHandle root, IDevelopmentLineHandle developmentLine) Sets the development line of the given root team area.

Method Detail

getRoots

java.util.Set getRoots()

Returns all root team areas. A root team area is a team area that does not have a parent team area. The returned set is unmodifiable and represents a snapshot of the set of roots at the point of the method invocation.

Returns:

the set of all root team areas (element type: ITeamAreaHandle)

addRoot

void addRoot(ITeamAreaHandle root,
           IDevelopmentLineHandle developmentLine)

Adds the given team area as a root to this hierarchy in the given development line. This method does not have any effect if the given team area is already a root in the given development line.

Parameters:

root - the new root

developmentLine - the development line to which the team area will be added or null

Throws:

TeamAreaHierarchyException - in case the given root is already a child in this hierarchy

java.lang.IllegalArgumentException - in case the given handle is already a root team area in another development line

promoteToRoot

void promoteToRoot(ITeamAreaHandle root)

Promotes the given team area to be a root of this hierarchy within its current development line.

Parameters:

root - a handle to the new root

Throws:

TeamAreaHierarchyException - in case the given handle already references a root in the hierarchy or is not part of this hierarchy

getParent

ITeamAreaHandle getParent(ITeamAreaHandle child)

Returns the parent of the given team area or null if the team area is a root.

Parameters:

child - the team area

Returns:

the parent or null if the team area does not have a parent (is a root)

Throws:

TeamAreaHierarchyException - if the child is not part of this hierarchy

getChildren

java.util.Set getChildren(ITeamAreaHandle parent)

Returns the children for the given team area. The returned set is unmodifiable and represents a snapshot of the set of children at the point of the method invocation.

Parameters:

parent - the parent team area

Returns:

the set of children (element type: ITeamAreaHandle)

Throws:

TeamAreaHierarchyException - if the parent is not part of this hierarchy

addChild

void addChild(ITeamAreaHandle parent,
            ITeamAreaHandle child)

Adds a given team area as a child to another given team area.

Parameters:

parent - the parent team area

child - the child team area

Throws:

TeamAreaHierarchyException - if the parent is not part of this hierarchy or the child already has a parent

remove

void remove(ITeamAreaHandle teamArea)

Removes the given team area from the hierarchy.

Parameters:

teamArea - the team area

Throws:

TeamAreaHierarchyException - if the team area is not part of this hierarchy or the team area has children

reparent

void reparent(ITeamAreaHandle newParent,
            ITeamAreaHandle child)

Adds a given team area as a child to another given team area when the child team area may already have a parent team area.

Parameters:

newParent - the parent team area

child - the child team area

Throws:

TeamAreaHierarchyException - if the parent is not part of this hierarchy

getTeamAreas

java.util.List getTeamAreas()

Returns a list of all team areas contained in this team area hierarchy.

Returns:

a list of team areas contained in this hierarchy (element type: ITeamAreaHandle)

getDevelopmentLine

IDevelopmentLineHandle getDevelopmentLine(ITeamAreaHandle teamAreaHandle)

Returns the development line to which the given team area belongs in this hierarchy or null if the team area does not belong to a development line. If the given handle is not a root, this method returns the development line which the handle inherits.

If the given team area is not explicitly assigned to a development line, this method will return the project development line, if any. To distinguish between team areas that are in the project development line and those that have no persisted development line set, use getRawDevelopmentLine(ITeamAreaHandle) instead.

Parameters:

teamAreaHandle - the team area handle

Returns:

the development line to which the given handle belongs in this hierarchy or null

Throws:

TeamAreaHierarchyException - if the team area is not part of this hierarchy

setDevelopmentLine

void setDevelopmentLine(ITeamAreaHandle root,
                      IDevelopmentLineHandle developmentLine)

Sets the development line of the given root team area. Has no effect if the given root team area is already in the given development line.

Parameters:

root - a handle to the root team area

developmentLine - the development line to set

Throws:

TeamAreaHierarchyException - in case the given handle is not already a root in this hierarchy

getRawDevelopmentLine

IDevelopmentLineHandle getRawDevelopmentLine(ITeamAreaHandle teamAreaHandle)

Returns the development line to which the given team area belongs in this hierarchy or null if the team area does not belong to a development line. If the given handle is not a root, this method returns the development line which the handle inherits.

Unlike getDevelopmentLine(ITeamAreaHandle), this method does not consider the implicitly assigned project development line. If a team area is not explicitly assigned to a development line, this method will always return null.

Parameters:

teamAreaHandle - the team area handle

Returns:

the development line to which the given handle belongs in this hierarchy or null

Throws:

TeamAreaHierarchyException - if the team area is not part of this hierarchy

Since:

0.7