fuego.papi
Enum StatusScope

java.lang.Object
  java.lang.Enum<StatusScope>
      fuego.papi.StatusScope

All Implemented Interfaces:

fuego.resources.Internationalizable, Serializable, Comparable<StatusScope>

public enum StatusScope
extends Enum<StatusScope>
implements fuego.resources.Internationalizable

Enumeration that represents the possible combination of instances status to set in a search filter Possible values are: - ONLY_INPROCESS: Only instances that are In Process - ONLY_COMPLETED: Only instances that are Completed - ONLY_ABORTED: Only instances that are Aborted - INPROCESS_AND_COMPLETED: Instances that are Completed or In Process - INPROCESS_AND_ABORTED: Instances that are In Process or Aborted - ABORTED_AND_COMPLETED: Instances that are Aborted or Completed - ALL: Instances in any status

Enum Constant Summary

ABORTED_AND_COMPLETED
Instances that are Aborted or Completed

ALL
Instances in any status

INPROCESS_AND_ABORTED
Instances that are In Process or Aborted

INPROCESS_AND_COMPLETED
Instances that are Completed or In Process

ONLY_ABORTED
Only instances that are Aborted

ONLY_COMPLETED
Only instances that are Completed

ONLY_INPROCESS
Only instances that are In Process

Method Summary

fuego.resources.Msg	getMsg()
String	getString()
String	getString(Locale locale)
boolean	isAborted()
boolean	isCompleted()
boolean	isInProcess()
static StatusScope	valueOf(boolean inProcess, boolean completed, boolean aborted) Creates a StatusScope with the combination of boolean values recieved as parameters.
static StatusScope	valueOf(String name) Returns the enum constant of this type with the specified name.
static StatusScope[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ONLY_INPROCESS

public static final StatusScope ONLY_INPROCESS

Only instances that are In Process

ONLY_COMPLETED

public static final StatusScope ONLY_COMPLETED

Only instances that are Completed

ONLY_ABORTED

public static final StatusScope ONLY_ABORTED

Only instances that are Aborted

INPROCESS_AND_COMPLETED

public static final StatusScope INPROCESS_AND_COMPLETED

Instances that are Completed or In Process

INPROCESS_AND_ABORTED

public static final StatusScope INPROCESS_AND_ABORTED

Instances that are In Process or Aborted

ABORTED_AND_COMPLETED

public static final StatusScope ABORTED_AND_COMPLETED

Instances that are Aborted or Completed

ALL

public static final StatusScope ALL

Instances in any status

Method Detail

values

public static final StatusScope[] values()

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

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

Returns:

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

valueOf

public static StatusScope valueOf(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:

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

getString

public String getString()

Specified by:

getString in interface fuego.resources.Internationalizable

getString

public String getString(Locale locale)

getMsg

public fuego.resources.Msg getMsg()

isInProcess

public boolean isInProcess()

isCompleted

public boolean isCompleted()

isAborted

public boolean isAborted()

valueOf

public static StatusScope valueOf(boolean inProcess,
                                  boolean completed,
                                  boolean aborted)

Creates a StatusScope with the combination of boolean values recieved as parameters. For example: //ALL ss = StatusScope.valueOf(inProcess : true, completed : true, aborted : true) //ONLY_INPROCESS ss = StatusScope.valueOf(inProcess : true, completed : false, aborted : false) //ONLY_ABORTED ss = StatusScope.valueOf(inProcess : false, completed : false, aborted : true) //ONLY_COMPLETED ss = StatusScope.valueOf(inProcess : false, completed : true, aborted : false) //INPROCESS_AND_COMPLETED ss = StatusScope.valueOf(inProcess : true, completed : true, aborted : false) //INPROCESS_AND_ABORTED ss = StatusScope.valueOf(inProcess : true, completed : false, aborted : true) //ABORTED_AND_COMPLETED ss = StatusScope.valueOf(inProcess : false, completed : true, aborted : true) Combination false, false, false is not a valid one.