gov.nih.nci.caarray.domain
Enum ConfigParamEnum

java.lang.Object
  extended by java.lang.Enum<ConfigParamEnum>
      extended by gov.nih.nci.caarray.domain.ConfigParamEnum
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<ConfigParamEnum>

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

Various configuration parameters.


Enum Constant Summary
BACKGROUND_THREAD_TRANSACTION_TIMEOUT
          the background import file thread transaction timeout in seconds.
CONFIRM_EMAIL_CONTENT
          Content of the confirmation email.
CONFIRM_EMAIL_SUBJECT
          Subject line of the confirmation email.
DEVELOPMENT_MODE
          Development mode flag.
EMAIL_FROM
          The email address to send email from.
FILE_RETRIEVAL_API_CHUNK_SIZE
          Chunk size for the RMIIO-based file retrieval API.
REG_EMAIL_SUBJECT
          Subject line of the registration email.
REG_EMAIL_TO
          What email address to send registration information to (ie, the helpdesk email address).
SCHEMA_VERSION
          caArray version number, for schema migration purposes.
SEND_ADMIN_EMAIL
          Boolean property on whether to send an email to the administrator after registering.
SEND_CONFIRM_EMAIL
          Boolean property on whether to send an confirmation email to the end user after registering.
STRUTS_MULTIPART_SAVEDIR
          the location to save uploaded files too.
SUBMIT_EXPERIMENT_EMAIL_HTML_CONTENT
          the html content for the submit experiment email.
SUBMIT_EXPERIMENT_EMAIL_PLAIN_CONTENT
          the plain-text content for the submit experiment email.
SUBMIT_EXPERIMENT_EMAIL_SUBJECT
          the subject for the submit experiment email.
THANKS_MESSAGE
          The thankyou for registering text that should appear after a user submits their registration.
 
Method Summary
static ConfigParamEnum valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static ConfigParamEnum[] 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

EMAIL_FROM

public static final ConfigParamEnum EMAIL_FROM
The email address to send email from.


SEND_CONFIRM_EMAIL

public static final ConfigParamEnum SEND_CONFIRM_EMAIL
Boolean property on whether to send an confirmation email to the end user after registering.


CONFIRM_EMAIL_SUBJECT

public static final ConfigParamEnum CONFIRM_EMAIL_SUBJECT
Subject line of the confirmation email.


CONFIRM_EMAIL_CONTENT

public static final ConfigParamEnum CONFIRM_EMAIL_CONTENT
Content of the confirmation email.


SEND_ADMIN_EMAIL

public static final ConfigParamEnum SEND_ADMIN_EMAIL
Boolean property on whether to send an email to the administrator after registering.


REG_EMAIL_TO

public static final ConfigParamEnum REG_EMAIL_TO
What email address to send registration information to (ie, the helpdesk email address).


REG_EMAIL_SUBJECT

public static final ConfigParamEnum REG_EMAIL_SUBJECT
Subject line of the registration email.


THANKS_MESSAGE

public static final ConfigParamEnum THANKS_MESSAGE
The thankyou for registering text that should appear after a user submits their registration.


SUBMIT_EXPERIMENT_EMAIL_SUBJECT

public static final ConfigParamEnum SUBMIT_EXPERIMENT_EMAIL_SUBJECT
the subject for the submit experiment email.


SUBMIT_EXPERIMENT_EMAIL_HTML_CONTENT

public static final ConfigParamEnum SUBMIT_EXPERIMENT_EMAIL_HTML_CONTENT
the html content for the submit experiment email.


SUBMIT_EXPERIMENT_EMAIL_PLAIN_CONTENT

public static final ConfigParamEnum SUBMIT_EXPERIMENT_EMAIL_PLAIN_CONTENT
the plain-text content for the submit experiment email.


STRUTS_MULTIPART_SAVEDIR

public static final ConfigParamEnum STRUTS_MULTIPART_SAVEDIR
the location to save uploaded files too.


BACKGROUND_THREAD_TRANSACTION_TIMEOUT

public static final ConfigParamEnum BACKGROUND_THREAD_TRANSACTION_TIMEOUT
the background import file thread transaction timeout in seconds.


DEVELOPMENT_MODE

public static final ConfigParamEnum DEVELOPMENT_MODE
Development mode flag. Should only be true for local development purposes.


SCHEMA_VERSION

public static final ConfigParamEnum SCHEMA_VERSION
caArray version number, for schema migration purposes.


FILE_RETRIEVAL_API_CHUNK_SIZE

public static final ConfigParamEnum FILE_RETRIEVAL_API_CHUNK_SIZE
Chunk size for the RMIIO-based file retrieval API.

Method Detail

values

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

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

valueOf

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