Package de.xima.fc.mdl.enums

Enum EResourceItemType

java.lang.Object

java.lang.Enum<EResourceItemType>

de.xima.fc.mdl.enums.EResourceItemType

All Implemented Interfaces:

INamedUiElement, Serializable, Comparable<EResourceItemType>

public enum EResourceItemType
extends Enum<EResourceItemType>
implements INamedUiElement

Enumeration of the different types of resources that can be selected in the configuration of workflow actions.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

See Also:

ISingleFileProviding, IMultiFileProviding

Enum Constant Summary

Enum Constants

Enum Constant	Description
ATTACHMENT_SEARCH	A form record attachment determined by a filename search
CLIENT	Resource from client scope
EXTERNAL	Resource referenced by an URL
FILE_PROVIDE_ACTION	Files provided by a workflow node.
FIRED_TRIGGER	Files provided by a workflow trigger.
FORM	Resource from form scope
UPLOAD	File from an form upload element

Field Summary

Fields inherited from interface de.xima.fc.interfaces.INamedUiElement

ATTR_DISPLAY_NAME

Method Summary

Modifier and Type	Method	Description
String	getDisplayName(Locale l)	The display name of this element in the given locale.
static EResourceItemType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static EResourceItemType[]	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

ATTACHMENT_SEARCH

public static final EResourceItemType ATTACHMENT_SEARCH

A form record attachment determined by a filename search

CLIENT

public static final EResourceItemType CLIENT

Resource from client scope

EXTERNAL

public static final EResourceItemType EXTERNAL

Resource referenced by an URL

FORM

public static final EResourceItemType FORM

Resource from form scope

FILE_PROVIDE_ACTION

public static final EResourceItemType FILE_PROVIDE_ACTION

Files provided by a workflow node. This must be either a workflow node that was already executed (such as a "create text file" action that created a file) or a node currently being executed (such as a loop node that iterates over files).

UPLOAD

public static final EResourceItemType UPLOAD

File from an form upload element

FIRED_TRIGGER

public static final EResourceItemType FIRED_TRIGGER

Files provided by a workflow trigger. This must be a trigger that fired during the current workflow execution.

Method Detail

values

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

Returns:

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

valueOf

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

NullPointerException - if the argument is null

getDisplayName

public String getDisplayName(Locale l)

Description copied from interface: INamedUiElement

The display name of this element in the given locale.

Specified by:

getDisplayName in interface INamedUiElement

Parameters:

l - The locale to get the display name for.

Returns:

The display name of this element in the given locale.