Package ch.systemsx.cisd.openbis.generic.shared.basic.dto

Enum DataSetArchivingStatus

java.lang.Object

java.lang.Enum<DataSetArchivingStatus>

ch.systemsx.cisd.openbis.generic.shared.basic.dto.DataSetArchivingStatus

All Implemented Interfaces:

com.google.gwt.user.client.rpc.IsSerializable, java.io.Serializable, java.lang.Comparable<DataSetArchivingStatus>

public enum DataSetArchivingStatus
extends java.lang.Enum<DataSetArchivingStatus>
implements com.google.gwt.user.client.rpc.IsSerializable

Status of data set archiving process.

                                                                                                                  |                                                         
                                                  
    -------> ARCHIVE_PENDING --------------> ARCHIVED 
    |                                            |             
    |                                            |  unarchive
    | archive(removeFromDS=true)                 |
    |                                            |  
    |                                            V             
    ----------------  AVAILABLE  <------- UNARCHIVE_PENDING
                      ^      ^  
                      |      |
                      |      |
                      |      | archive(removeFromDS=false)
                      |      |
                      |      |
  LOCKED <------------|      |-------------> BACKUP_PENDING
 
 
 

Enum Constant Summary

Enum Constants

Enum Constant	Description
ARCHIVE_PENDING
ARCHIVED
AVAILABLE
BACKUP_PENDING
LOCKED
UNARCHIVE_PENDING

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDescription()
boolean	isAvailable()
boolean	isDeletable()	return true if users are allowed to delete datasets with this status.
static DataSetArchivingStatus	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static DataSetArchivingStatus[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

AVAILABLE

public static final DataSetArchivingStatus AVAILABLE

LOCKED

public static final DataSetArchivingStatus LOCKED

ARCHIVED

public static final DataSetArchivingStatus ARCHIVED

UNARCHIVE_PENDING

public static final DataSetArchivingStatus UNARCHIVE_PENDING

ARCHIVE_PENDING

public static final DataSetArchivingStatus ARCHIVE_PENDING

BACKUP_PENDING

public static final DataSetArchivingStatus BACKUP_PENDING

Method Detail

values

public static DataSetArchivingStatus[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DataSetArchivingStatus c : DataSetArchivingStatus.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DataSetArchivingStatus valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getDescription

public java.lang.String getDescription()

isAvailable

public boolean isAvailable()

isDeletable

public boolean isDeletable()

return true if users are allowed to delete datasets with this status.