com.starteam
Class PurgeController.Status

java.lang.Object
  extended by com.starteam.PurgeController.Status
Enclosing class:
PurgeController

public static final class PurgeController.Status
extends java.lang.Object

Describes the current state of the purge service


Field Summary
static PurgeController.Status COMPLETED
          Specifies that the service has completed.
static PurgeController.Status FAILED
          Specifies that the service has failed.
static PurgeController.Status IN_PROGRESS
          Specifies that the service is running.
static PurgeController.Status READY
          Specifies that the service is ready to start.
static PurgeController.Status STOPPING
          Specifies that the service is stopping.
 
Method Summary
static PurgeController.Status[] getAll()
          Returns an array of all Status instances
 java.lang.String getName()
          Returns a description of the purge status
 int getValue()
          Purge status
 java.lang.String toString()
          Returns a String representation of this Purge Status
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

READY

public static final PurgeController.Status READY
Specifies that the service is ready to start.


IN_PROGRESS

public static final PurgeController.Status IN_PROGRESS
Specifies that the service is running.


COMPLETED

public static final PurgeController.Status COMPLETED
Specifies that the service has completed.


STOPPING

public static final PurgeController.Status STOPPING
Specifies that the service is stopping.


FAILED

public static final PurgeController.Status FAILED
Specifies that the service has failed.

Method Detail

getValue

public int getValue()
Purge status

Returns:
the status of the purge.

getName

public java.lang.String getName()
Returns a description of the purge status

Returns:
a description of the status of the purge.

getAll

public static final PurgeController.Status[] getAll()
Returns an array of all Status instances

Returns:
MergeAction[] an array of all Status instances

toString

public java.lang.String toString()
Returns a String representation of this Purge Status

Overrides:
toString in class java.lang.Object
Returns:
String a String representation of this Purge Status


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