com.starteam
Class Task.ProcessUsage

java.lang.Object
  extended by com.starteam.EnumeratedValue
      extended by com.starteam.Task.ProcessUsage
All Implemented Interfaces:
java.io.Serializable
Enclosing class:
Task

public static final class Task.ProcessUsage
extends EnumeratedValue

Indicates the type of operation that created a given process task and its associated process links.

See Also:
Serialized Form

Field Summary
static Task.ProcessUsage[] ALL
          All supported ProcessUsage values.
static Task.ProcessUsage CHECKIN
          For adding and checking in files.
static Task.ProcessUsage OTHER
          Not a process task.
static Task.ProcessUsage PROMOTE
          For a Promote view compare/merge session.
static Task.ProcessUsage REBASE
          For a Rebase view compare/merge session.
static Task.ProcessUsage REPLICATE
          For a Replicate view compare/merge session.
 
Method Summary
 boolean equals(java.lang.Object o)
          Compares this EnumeratedValue instance with another one.
static Task.ProcessUsage fromID(int id)
          Gets the ProcessUsage value corresponding to the given ID.
static Task.ProcessUsage fromValue(EnumeratedValue value)
          Gets the Compression value corresponding to the given EnumeratedValue.
 int getCode()
          Return the enum code for this object.
 java.lang.String getDisplayName()
          Returns the display name of the Process Usage.
 int getID()
          The ID of the corresponding EnumeratedValue, as defined in StatusProperty.
 java.lang.String getName()
          return the name of this object
 int hashCode()
          returns a unique hash for this instance
 
Methods inherited from class com.starteam.EnumeratedValue
addChild, assignParent, copy, disable, enable, findChild, getChildValues, getDebugString, getDepthInHierarchy, getDisplayNameTranslations, getInternalName, getParentValue, getSortOrder, hasChildValues, isClosedState, isDisabled, isEnabled, isEqualTo, isLeafValue, isRootValue, isSelectable, setAfter, setChildValues, setClosedState, setDisplayName, setDisplayNameTranslations, setEnabled, setInternalName, setSelectable, setSortOrder, toString
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

OTHER

public static final Task.ProcessUsage OTHER
Not a process task.


CHECKIN

public static final Task.ProcessUsage CHECKIN
For adding and checking in files.


PROMOTE

public static final Task.ProcessUsage PROMOTE
For a Promote view compare/merge session.


REBASE

public static final Task.ProcessUsage REBASE
For a Rebase view compare/merge session.


REPLICATE

public static final Task.ProcessUsage REPLICATE
For a Replicate view compare/merge session.


ALL

public static final Task.ProcessUsage[] ALL
All supported ProcessUsage values.

Method Detail

getID

public int getID()
The ID of the corresponding EnumeratedValue, as defined in StatusProperty.

Returns:
The ID of this Status value.
See Also:
Task.Type.StatusProperty.NAME

getCode

public int getCode()
Return the enum code for this object.

Overrides:
getCode in class EnumeratedValue
Returns:
the enum code for this object.

getName

public java.lang.String getName()
return the name of this object

Returns:
the name of this object

getDisplayName

public java.lang.String getDisplayName()
Returns the display name of the Process Usage.

Overrides:
getDisplayName in class EnumeratedValue
Returns:
the display name of this Process Usage

fromValue

public static Task.ProcessUsage fromValue(EnumeratedValue value)
Gets the Compression value corresponding to the given EnumeratedValue.

Parameters:
value - One of the EnumeratedValues of a ProcessUsageProperty.
Returns:
The corresponding ProcessUsage value, or null.

fromID

public static Task.ProcessUsage fromID(int id)
Gets the ProcessUsage value corresponding to the given ID.

Parameters:
id - The ID of a Compression value.
Returns:
The corresponding Compression value, or null.

equals

public boolean equals(java.lang.Object o)
Description copied from class: EnumeratedValue
Compares this EnumeratedValue instance with another one. Returns true if their properties match, false otherwise

Overrides:
equals in class EnumeratedValue
Parameters:
o - The other EnumeratedValue instance
Returns:
boolean true if the two EnumeratedValues are equals

hashCode

public int hashCode()
Description copied from class: EnumeratedValue
returns a unique hash for this instance

Overrides:
hashCode in class EnumeratedValue
Returns:
a unique hash for this instance


StarTeam SDK 14.0, Build 21
Copyright © 2003-2012 Borland Software Corporation. All rights reserved.