org.cyclos.model.system.operations

Enum CustomOperationShowForm

java.lang.Object

java.lang.Enum<CustomOperationShowForm>

org.cyclos.model.system.operations.CustomOperationShowForm

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CustomOperationShowForm>, HasMessageKey

public enum CustomOperationShowForm
extends java.lang.Enum<CustomOperationShowForm>
implements HasMessageKey

Determines in which parameters condition the form is shown

Author:

acastro

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALWAYS Always show the parameters form
MISSING_ANY Show form only if any parameter (optional or required) is missing
MISSING_REQUIRED Show form only if required parameters are missing

Method Summary

Modifier and Type	Method and Description
MessageKey	getMessageKey()
boolean	showForm(boolean hasMissingRequired, boolean hasMissingOptional)
static CustomOperationShowForm	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CustomOperationShowForm[]	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

MISSING_REQUIRED

public static final CustomOperationShowForm MISSING_REQUIRED

Show form only if required parameters are missing

MISSING_ANY

public static final CustomOperationShowForm MISSING_ANY

Show form only if any parameter (optional or required) is missing

ALWAYS

public static final CustomOperationShowForm ALWAYS

Always show the parameters form

Method Detail

values

public static CustomOperationShowForm[] 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 (CustomOperationShowForm c : CustomOperationShowForm.values())
    System.out.println(c);

Returns:

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

valueOf

public static CustomOperationShowForm 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

getMessageKey

public MessageKey getMessageKey()

Specified by:

getMessageKey in interface HasMessageKey

showForm

public boolean showForm(boolean hasMissingRequired,
                        boolean hasMissingOptional)