Package io.guise.framework.platform.web

Enum AbstractWebPlatformFileCollectorDepictor.WebPlatformFileCollectorCommand

java.lang.Object

java.lang.Enum<AbstractWebPlatformFileCollectorDepictor.WebPlatformFileCollectorCommand>

io.guise.framework.platform.web.AbstractWebPlatformFileCollectorDepictor.WebPlatformFileCollectorCommand

All Implemented Interfaces:

com.globalmentor.lex.Identifier, com.globalmentor.lex.Token, PlatformCommand, WebPlatformCommand, java.io.Serializable, java.lang.Comparable<AbstractWebPlatformFileCollectorDepictor.WebPlatformFileCollectorCommand>

Enclosing class:

AbstractWebPlatformFileCollectorDepictor

public static enum AbstractWebPlatformFileCollectorDepictor.WebPlatformFileCollectorCommand
extends java.lang.Enum<AbstractWebPlatformFileCollectorDepictor.WebPlatformFileCollectorCommand>
implements WebPlatformCommand

The web commands for controlling the platform file collector.

Enum Constant Summary

Enum Constants

Enum Constant	Description
FILE_BROWSE	The command to allow the user to browse to select a file.
FILE_CANCEL	The command to cancel a transfer.
FILE_UPLOAD	The command to initiate an upload.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DESTINATION_URI_PROPERTY	The property for specifying the destination URI of a file upload.
static java.lang.String	ID_PROPERTY	The property for specifying the ID of a file.
static java.lang.String	MULTIPLE_PROPERTY	The property for specifying whether multiple files should be selected.

Method Summary

Modifier and Type	Method	Description
static AbstractWebPlatformFileCollectorDepictor.WebPlatformFileCollectorCommand	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static AbstractWebPlatformFileCollectorDepictor.WebPlatformFileCollectorCommand[]	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

FILE_BROWSE

public static final AbstractWebPlatformFileCollectorDepictor.WebPlatformFileCollectorCommand FILE_BROWSE

The command to allow the user to browse to select a file. parameters: "multiple":"multiple"}

FILE_CANCEL

public static final AbstractWebPlatformFileCollectorDepictor.WebPlatformFileCollectorCommand FILE_CANCEL

The command to cancel a transfer. parameters: {"id":"fileReferenceID"}

FILE_UPLOAD

public static final AbstractWebPlatformFileCollectorDepictor.WebPlatformFileCollectorCommand FILE_UPLOAD

The command to initiate an upload. parameters: {"id":"fileReferenceID", "destinationURI":destinationURI}

Field Detail

DESTINATION_URI_PROPERTY

public static final java.lang.String DESTINATION_URI_PROPERTY

The property for specifying the destination URI of a file upload.

See Also:

Constant Field Values

ID_PROPERTY

public static final java.lang.String ID_PROPERTY

The property for specifying the ID of a file.

See Also:

Constant Field Values

MULTIPLE_PROPERTY

public static final java.lang.String MULTIPLE_PROPERTY

The property for specifying whether multiple files should be selected.

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

public static AbstractWebPlatformFileCollectorDepictor.WebPlatformFileCollectorCommand 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