com.appiancorp.suiteapi.process.framework

Enum Required

java.lang.Object

java.lang.Enum<Required>

com.appiancorp.suiteapi.process.framework.Required

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Required>

public enum Required
extends java.lang.Enum<Required>

Declares whether the input parameter is required.

Enum Constant Summary

Enum Constants

Enum Constant and 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 and Description
long	getAcsValue()
static Required	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Required[]	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

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 Detail

values

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

Returns:

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

valueOf

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

getAcsValue

public long getAcsValue()