org.opencms.ugc.shared

Enum CmsUgcConstants.ErrorCode

java.lang.Object

java.lang.Enum<CmsUgcConstants.ErrorCode>

org.opencms.ugc.shared.CmsUgcConstants.ErrorCode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CmsUgcConstants.ErrorCode>

Enclosing class:

CmsUgcConstants

public static enum CmsUgcConstants.ErrorCode
extends java.lang.Enum<CmsUgcConstants.ErrorCode>

Enum representing the different types of errors. The string values of these enum values are intended for use in JavaScript error handling functions.

Enum Constant Summary

Enum Constants

Enum Constant and Description
errConfiguration Configuration error.
errInvalidAction Invalid action error.
errInvalidExtension Error when user tries to upload a file with a file extension which is not among the configured file extensions.
errMaxContentsExceeded Error when the maximum number of contents in the content directory is reached.
errMaxQueueLengthExceeded Error when the maximum number of entries in the form session request queue is reached.
errMaxUploadSizeExceeded Error when uploaded files exceed the configured maximum upload size.
errMisc Miscellaneous other errors.
errNoUploadAllowed Error when trying to upload a file and uploads are not allowed.
errValidation Validation error.

Method Summary

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

errInvalidAction

public static final CmsUgcConstants.ErrorCode errInvalidAction

Invalid action error.

errConfiguration

public static final CmsUgcConstants.ErrorCode errConfiguration

Configuration error.

errNoUploadAllowed

public static final CmsUgcConstants.ErrorCode errNoUploadAllowed

Error when trying to upload a file and uploads are not allowed.

errMaxContentsExceeded

public static final CmsUgcConstants.ErrorCode errMaxContentsExceeded

Error when the maximum number of contents in the content directory is reached.

errMaxQueueLengthExceeded

public static final CmsUgcConstants.ErrorCode errMaxQueueLengthExceeded

Error when the maximum number of entries in the form session request queue is reached.

errInvalidExtension

public static final CmsUgcConstants.ErrorCode errInvalidExtension

Error when user tries to upload a file with a file extension which is not among the configured file extensions.

errValidation

public static final CmsUgcConstants.ErrorCode errValidation

Validation error.

errMisc

public static final CmsUgcConstants.ErrorCode errMisc

Miscellaneous other errors.

errMaxUploadSizeExceeded

public static final CmsUgcConstants.ErrorCode errMaxUploadSizeExceeded

Error when uploaded files exceed the configured maximum upload size.

Method Detail

values

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

Returns:

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

valueOf

public static CmsUgcConstants.ErrorCode 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