com.starbase.starteam
Class TaskDependency

java.lang.Object
  |
  +--com.starbase.starteam.CacheRef
        |
        +--com.starbase.starteam.NamedCacheRef
              |
              +--com.starbase.starteam.TypedResource
                    |
                    +--com.starbase.starteam.SimpleTypedResource
                          |
                          +--com.starbase.starteam.TaskDependency

All Implemented Interfaces:

java.lang.Cloneable

public class TaskDependency

extends SimpleTypedResource

This is a class reprensenting a dependency between two tasks.

Method Summary

boolean	equals(java.lang.Object source) returns true if this object instance is equal to the source
int	getID() Returns the integer identifier for this task dependency.
int	getLagTime() Returns the lag time for this task dependency.
int[]	getPossiblePredecessorType() Returns the possible enum codes that are valid values for the PredecessorType property.
int	getPredecessorID() Returns the ObjectID of the predecessor Task.
int	getPredecessorType() Returns the PredecessorType of this task dependency.
java.lang.String	getPredecessorTypeDisplayName(int value) Returns a user-friendly display name for the given PredecessorType value.
int	getTaskID() Returns the ObjectID of the successor Task.
int	hashCode() returns a unique hash for all instances of this type
boolean	isDirty() Returns true if this task dependency has been modified but not yet saved.
java.lang.Object	put(java.lang.String propertyName, java.lang.Object value) Sets the value of the specified property and return the old value.
void	setLagTime(int lagTime) Sets the lag time for this task dependency.
void	setPredecessorType(int Type) Sets the PredecessorType of this task dependency.

Methods inherited from class com.starbase.starteam.SimpleTypedResource

get, getByteArray, getDouble, getEnumDisplayName, getInt, getIntArray, getOLEDate, getPossibleValues, getPropertyNames, getString, getType, getTypeNames, putByPropertyID

Methods inherited from class com.starbase.starteam.TypedResource

addToIntArray, removeFromIntArray, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getTaskID

public int getTaskID()

Returns the ObjectID of the successor Task.

Returns:

The ObjectID of the successor Task.

See Also:

PropertyNames.TASKDEPENDENCY_TASK_ID, PropertyNames.OBJECT_ID

getID

public int getID()

Returns the integer identifier for this task dependency.

Overrides:

getID in class SimpleTypedResource

Returns:

The integer identifier for this task dependency. Same as getTaskID.

See Also:

TaskDependency.getTaskID()

getPredecessorID

public int getPredecessorID()

Returns the ObjectID of the predecessor Task.

Returns:

The ObjectID of the predecessor Task.

See Also:

PropertyNames.TASKDEPENDENCY_PREDECESSOR_ID, PropertyNames.OBJECT_ID

getLagTime

public int getLagTime()

Returns the lag time for this task dependency.

Returns:

the lag time for this task dependency.

See Also:

PropertyNames.TASKDEPENDENCY_LAG_TIME

setLagTime

public void setLagTime(int lagTime)

Sets the lag time for this task dependency.

Parameters:

lagTime - the lag time for this dependency.

See Also:

PropertyNames.TASKDEPENDENCY_LAG_TIME

getPredecessorType

public int getPredecessorType()

Returns the PredecessorType of this task dependency.

Returns:

the PredecessorType of this task dependency.

See Also:

TaskDependency.getPossiblePredecessorType(), TaskDependency.getPredecessorTypeDisplayName(int), PropertyNames.TASKDEPENDENCY_TYPE

setPredecessorType

public void setPredecessorType(int Type)

Sets the PredecessorType of this task dependency.

Parameters:

Type - the new PredecessorType for this task dependency.

getPossiblePredecessorType

public int[] getPossiblePredecessorType()

Returns the possible enum codes that are valid values for the PredecessorType property. This is really a convenience method for accessing Property.getEnumValues for this property.

Returns:

the possible values for the PredecessorType property.

See Also:

TaskDependency.getPredecessorType(), TaskDependency.getPredecessorTypeDisplayName(int), TypedResource.getPossibleValues(java.lang.String), PropertyNames.TASKDEPENDENCY_TYPE

getPredecessorTypeDisplayName

public java.lang.String getPredecessorTypeDisplayName(int value)

Returns a user-friendly display name for the given PredecessorType value. This is really a convenience method for accessing TypedResource.getEnumDisplayName for this property.

Returns:

a user-friendly display name for the given PredecessorType value.

See Also:

TaskDependency.getPredecessorType(), TaskDependency.getPossiblePredecessorType(), TypedResource.getEnumDisplayName(java.lang.String, int), PropertyNames.TASKDEPENDENCY_TYPE

put

public java.lang.Object put(java.lang.String propertyName,
                            java.lang.Object value)
                     throws NoSuchPropertyException,
                            java.lang.ClassCastException

Sets the value of the specified property and return the old value.

Overrides:

put in class SimpleTypedResource

Parameters:

propertyName - the name of the property to set

value - the new value to set for the specified property

Returns:

the old property value

Throws:

NoSuchPropertyException - if the named property does not exist

java.lang.ClassCastException - if the value is of the wrong type for the specified property

isDirty

public boolean isDirty()

Returns true if this task dependency has been modified but not yet saved. Task dependencies are saved but updating the to corresponding Task object.

Returns:

true if this task dependency has been modified but not yet saved.

See Also:

Task.update()

equals

public boolean equals(java.lang.Object source)

returns true if this object instance is equal to the source

Overrides:

equals in class SimpleTypedResource

Parameters:

source - Object the source to comapre with

Returns:

boolean true if this object is equal to the source

hashCode

public int hashCode()

returns a unique hash for all instances of this type

Overrides:

hashCode in class SimpleTypedResource

Returns:

int a unique hash for all instances of this type