edu.jhu.tmaj.config
Enum ClientConstants.ClientConfigKey

java.lang.Object
  java.lang.Enum<ClientConstants.ClientConfigKey>
      edu.jhu.tmaj.config.ClientConstants.ClientConfigKey

All Implemented Interfaces:

ConfigKey, java.io.Serializable, java.lang.Comparable<ClientConstants.ClientConfigKey>

Enclosing class:

ClientConstants

public static enum ClientConstants.ClientConfigKey
extends java.lang.Enum<ClientConstants.ClientConfigKey>
implements ConfigKey

The options in the client config file.

Enum Constant Summary

BYPASS_LOGIN
True if the user should automatically log in with BYPASS_USERNAME and BYPASS_PASSWORD.

BYPASS_PASSWORD
see bypass_login.

BYPASS_USERNAME
see bypass_login.

DISPLAY_ARIOL_FILE_RENAMER_TAB
True if the ARIOL File Renamer tab should be displayed in the import application.

DISPLAY_PATIENTS_TAB
True if the Patients tab should be displayed in the Specimens application.

MESSAGE
A message to anyone using this version displayed on the login screen.

OVERRIDE_CONFIG_FILE_NAME
A config file on local clients machine that may override any default values.

SAMPLES_APPLICATION_ENABLED
True if Cleveland Clinic's Samples application should be accessible.

SAVE_CLICKS_IN_DEVELOPMENT
True if the Project Tree in the Images application should automatically be expanded to save a couple of clicks (and thus time).

SCAN_SCOPE_URL
ScanScope URL for accessing ImageScope

SERVLET_URL
The URL of the SERVLET to which the client connects to send Requests.

SITE
A brief description of the server site to where the client is connecting.

Method Summary

ConfigKeyType	getType() Returns the type of the Config Key, such as a String or URL.
boolean	isRequired() Returns true if the Config Key must be present and must have a value for TMAJ to work.
static ClientConstants.ClientConfigKey	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ClientConstants.ClientConfigKey[]	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

SERVLET_URL

public static final ClientConstants.ClientConfigKey SERVLET_URL

The URL of the SERVLET to which the client connects to send Requests.

SITE

public static final ClientConstants.ClientConfigKey SITE

A brief description of the server site to where the client is connecting. This typically includes the institution name, like JHU, and a description of the running version, such as production, demo, or test. Example: JHU Demo.

MESSAGE

public static final ClientConstants.ClientConfigKey MESSAGE

A message to anyone using this version displayed on the login screen. Example: This version is for test only.

OVERRIDE_CONFIG_FILE_NAME

public static final ClientConstants.ClientConfigKey OVERRIDE_CONFIG_FILE_NAME

A config file on local clients machine that may override any default values.

SAVE_CLICKS_IN_DEVELOPMENT

public static final ClientConstants.ClientConfigKey SAVE_CLICKS_IN_DEVELOPMENT

True if the Project Tree in the Images application should automatically be expanded to save a couple of clicks (and thus time).

SAMPLES_APPLICATION_ENABLED

public static final ClientConstants.ClientConfigKey SAMPLES_APPLICATION_ENABLED

True if Cleveland Clinic's Samples application should be accessible.

DISPLAY_ARIOL_FILE_RENAMER_TAB

public static final ClientConstants.ClientConfigKey DISPLAY_ARIOL_FILE_RENAMER_TAB

True if the ARIOL File Renamer tab should be displayed in the import application. The ARIOL machine is currently only used at Cleveland Clinic and is unnecessary for most sites.

DISPLAY_PATIENTS_TAB

public static final ClientConstants.ClientConfigKey DISPLAY_PATIENTS_TAB

True if the Patients tab should be displayed in the Specimens application. JHU has requested this not be displayed.

BYPASS_LOGIN

public static final ClientConstants.ClientConfigKey BYPASS_LOGIN

True if the user should automatically log in with BYPASS_USERNAME and BYPASS_PASSWORD. Saves time during development. On the intro screen,when the user presses the log-in button, they are automatically logged in instead of having to type in a username and password.

BYPASS_USERNAME

public static final ClientConstants.ClientConfigKey BYPASS_USERNAME

see bypass_login.

BYPASS_PASSWORD

public static final ClientConstants.ClientConfigKey BYPASS_PASSWORD

see bypass_login.

SCAN_SCOPE_URL

public static final ClientConstants.ClientConfigKey SCAN_SCOPE_URL

ScanScope URL for accessing ImageScope

Method Detail

values

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

Returns:

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

valueOf

public static ClientConstants.ClientConfigKey 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

isRequired

public boolean isRequired()

Description copied from interface: ConfigKey

Returns true if the Config Key must be present and must have a value for TMAJ to work.

Specified by:

isRequired in interface ConfigKey

getType

public ConfigKeyType getType()

Description copied from interface: ConfigKey

Returns the type of the Config Key, such as a String or URL.

Specified by:

getType in interface ConfigKey