Package com.appiancorp.suiteapi.process.framework

Enum Class Required

java.lang.Object

java.lang.Enum<Required>

com.appiancorp.suiteapi.process.framework.Required

All Implemented Interfaces:

Serializable, Comparable<Required>, Constable

public enum Required
extends Enum<Required>

Declares whether the input parameter is required.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALWAYS	Indicates that the input is always required.
OPTIONAL	Indicates that the input is not required, but a form element mapping to the ACP can be made required on the corresponding form.

Method Summary

Modifier and Type	Method	Description
long	getAcsValue()
static Required	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Required[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

OPTIONAL

public static final Required OPTIONAL

Indicates that the input is not required, but a form element mapping to the ACP can be made required on the corresponding form.

ALWAYS

public static final Required ALWAYS

Indicates that the input is always required. Any form element mapping to this ACP will also be required.

Method Details

values

public static Required[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static Required valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getAcsValue

public long getAcsValue()