org.tigris.scarab.util
Interface ScarabConstants


public interface ScarabConstants

A place to put public final static strings and other constants.

Version:
$Id: ScarabConstants.java 10198 2006-07-03 23:33:30Z dabbous $
Author:
Jon S. Stevens

Field Summary
static java.lang.String ACTION
          This is the key value that stores the name of the action that is currently being executed.
static java.lang.String ARCHIVE_EMAIL_ADDRESS
           
static java.lang.String ATTACHMENTS_REPO_KEY
           
static java.lang.String AUTO_APPROVED_ROLES
          Scarab.properties key for roles to be automatically approved.
static java.lang.String BACK_TEMPLATE
          This is the key value that stores the name of the template to go back to to (used in wizards)
static int BLOCKED_MODULE_ISSUE_TYPE_OBJECT
           
static java.lang.String BLOCKS
           
static java.lang.String CANCEL_TEMPLATE
          This is the key value that stores the name of the template to cancel to.
static java.lang.String COMMENT_RENDER_ENGINE
          The default comment rendering engine
static java.lang.String CURRENT_ADMIN_MENU
           
static java.lang.String CURRENT_ISSUE_TYPE
           
static java.lang.String CURRENT_MITLIST_ID
           
static java.lang.String CURRENT_MITLISTITEM
           
static java.lang.String CURRENT_MODULE
           
static java.lang.String CURRENT_QUERY
           
static java.lang.String CURRENT_REPORT
           
static java.lang.String DATE_FORMAT
          format for displaying dates
static java.lang.String DEBUG
          Key passed around in the query string which tracks the current module.
static java.lang.String DEFAULT_BUNDLE_NAME
          The default base for resolving ResourceBundles.
static java.lang.String DEFAULT_EMAIL_ENCODING_KEY
          Scarab.properties key for email encoding property.
static java.util.Locale DEFAULT_LOCALE
          Default locale, taken from configuration files.
static java.lang.String DROPDOWN_LIST
          An attribute type
static int GLOBAL_ATTRIBUTE_OBJECT
           
static java.lang.String HISTORY_SCREEN
           
static java.lang.String HTTP_DOMAIN
           
static java.lang.String HTTP_PORT
           
static java.lang.String HTTP_SCHEME
           
static java.lang.String HTTP_SCRIPT_NAME
           
static java.lang.String ID
          This is the key value that stores the issue id.
static java.lang.String IMPORT_ADD_USERS
           
static java.lang.String INSTANCE_ID
          This name will be used to distinguish specific scarab application from other instances that it may interact with (in the future).
static java.lang.String INTAKE_TOOL
          The name used for the Intake tool
static java.lang.Integer INTEGER_0
           
static java.lang.String INVALID_SEARCH_CHARACTERS
          list of invalid characters when doing searches
static java.lang.String IS_BLOCKED
           
static java.lang.String ISO_DATE_PATTERN
          The ISO date format that we accept when users enter dates.
static java.lang.String ISO_DATETIME_PATTERN
          The ISO date/time format that we accept when users enter dates and times.
static java.lang.String ISSUE_ID_LIST
          The list of issue id's resulting from a search.
static int ISSUE_MAX_ASSIGN
          The maximum number of issues for batch assign.
static int ISSUE_MAX_COPY
          The maximum number of issues for batch copy.
static int ISSUE_MAX_MOVE
          The maximum number of issues for batch move.
static int ISSUE_MAX_VIEW
          The maximum number of issues for batch view of detail.
static java.lang.String ISSUE_VIEW_ALL
          Value of the session parameter to view the issue in long form.
static java.lang.String LAST_TEMPLATE
          This is the key value that stores the name of the template to go back to to (used in wizards)
static java.lang.String LOCALIZATION_TOOL
          The name used for the Localization tool
static int MAX_WORD_RATING
          This is maximum rating for a word.
static int MODULE_ATTRIBUTE_OBJECT
           
static java.lang.String NEW_ISSUE_TYPE
           
static java.lang.String NEW_MODULE
           
static java.lang.String NEXT_TEMPLATE
          This is the key value that stores the name of the template to execute next.
static java.lang.String NO_PERMISSION_MESSAGE
          The message the user sees if they try to perform an action For which they have no permissions.
static java.lang.String OTHER_TEMPLATE
          This is the key value that stores the name of the template other than the next, or cancel, where a user can go depending on an action.
static java.lang.String PROJECT_CHANGE_BOX
          Deprecated. No longer used
static int QUERY_MAX_FILTER_CRITERIA
           
static int QUERY_MAX_JOIN
           
static java.lang.String REMOVE_CURRENT_MITLIST_QKEY
           
static java.lang.String REMOVE_CURRENT_REPORT
           
static int REPORT_MAX_CRITERIA
          The maximumn number of report headings
static java.lang.String REPORTING_ISSUE
           
static java.lang.String SCARAB_GLOBAL_TOOL
          Collection of useful methods
static java.lang.String SCARAB_LINK_TOOL
          Name of the scarab Link Tool
static java.lang.String SCARAB_REQUEST_TOOL
          Primary System Object
static java.lang.String SECURITY_ADMIN_TOOL
          The name used for the Security Admin tool
static java.lang.String SECURITY_TOOL
          The name used for the Security tool
static java.lang.String SESSION_REGISTER
          the registration code uses this in order to store an object into the data.getUser().getTemp() hashtable. this is the key value and is used across several classes.
static java.lang.String SINGLE_SCREEN_ONLY
          Scarab.properties key for restricting viewIssue to long form (single screen).
static java.lang.String TAB_KEY
          key used to store session preference for long issue view vs. tabs used in get/setTemp within ScarabUser.
static java.lang.String TEMPLATE
          This is the key value that stores the name of the template that is currently being executed.
static java.lang.String THREAD_QUERY_KEY
           
static int TRANSITION_OBJECT
           
static java.lang.String USER_SELECTED_MODULE
           
 

Field Detail

SESSION_REGISTER

public static final java.lang.String SESSION_REGISTER
the registration code uses this in order to store an object into the data.getUser().getTemp() hashtable. this is the key value and is used across several classes.

See Also:
Constant Field Values

NEXT_TEMPLATE

public static final java.lang.String NEXT_TEMPLATE
This is the key value that stores the name of the template to execute next.

See Also:
Constant Field Values

CANCEL_TEMPLATE

public static final java.lang.String CANCEL_TEMPLATE
This is the key value that stores the name of the template to cancel to.

See Also:
Constant Field Values

BACK_TEMPLATE

public static final java.lang.String BACK_TEMPLATE
This is the key value that stores the name of the template to go back to to (used in wizards)

See Also:
Constant Field Values

LAST_TEMPLATE

public static final java.lang.String LAST_TEMPLATE
This is the key value that stores the name of the template to go back to to (used in wizards)

See Also:
Constant Field Values

TEMPLATE

public static final java.lang.String TEMPLATE
This is the key value that stores the name of the template that is currently being executed.

See Also:
Constant Field Values

ACTION

public static final java.lang.String ACTION
This is the key value that stores the name of the action that is currently being executed.

See Also:
Constant Field Values

OTHER_TEMPLATE

public static final java.lang.String OTHER_TEMPLATE
This is the key value that stores the name of the template other than the next, or cancel, where a user can go depending on an action.

See Also:
Constant Field Values

ID

public static final java.lang.String ID
This is the key value that stores the issue id.

See Also:
Constant Field Values

SCARAB_REQUEST_TOOL

public static final java.lang.String SCARAB_REQUEST_TOOL
Primary System Object

See Also:
Constant Field Values

SCARAB_LINK_TOOL

public static final java.lang.String SCARAB_LINK_TOOL
Name of the scarab Link Tool

See Also:
Constant Field Values

SCARAB_GLOBAL_TOOL

public static final java.lang.String SCARAB_GLOBAL_TOOL
Collection of useful methods

See Also:
Constant Field Values

INTAKE_TOOL

public static final java.lang.String INTAKE_TOOL
The name used for the Intake tool

See Also:
Constant Field Values

SECURITY_TOOL

public static final java.lang.String SECURITY_TOOL
The name used for the Security tool

See Also:
Constant Field Values

SECURITY_ADMIN_TOOL

public static final java.lang.String SECURITY_ADMIN_TOOL
The name used for the Security Admin tool

See Also:
Constant Field Values

LOCALIZATION_TOOL

public static final java.lang.String LOCALIZATION_TOOL
The name used for the Localization tool

See Also:
Constant Field Values

DEBUG

public static final java.lang.String DEBUG
Key passed around in the query string which tracks the current module.

See Also:
Constant Field Values

CURRENT_MODULE

public static final java.lang.String CURRENT_MODULE
See Also:
Constant Field Values

CURRENT_ISSUE_TYPE

public static final java.lang.String CURRENT_ISSUE_TYPE
See Also:
Constant Field Values

CURRENT_ADMIN_MENU

public static final java.lang.String CURRENT_ADMIN_MENU
See Also:
Constant Field Values

REPORTING_ISSUE

public static final java.lang.String REPORTING_ISSUE
See Also:
Constant Field Values

CURRENT_REPORT

public static final java.lang.String CURRENT_REPORT
See Also:
Constant Field Values

REMOVE_CURRENT_REPORT

public static final java.lang.String REMOVE_CURRENT_REPORT
See Also:
Constant Field Values

HISTORY_SCREEN

public static final java.lang.String HISTORY_SCREEN
See Also:
Constant Field Values

NEW_MODULE

public static final java.lang.String NEW_MODULE
See Also:
Constant Field Values

NEW_ISSUE_TYPE

public static final java.lang.String NEW_ISSUE_TYPE
See Also:
Constant Field Values

CURRENT_QUERY

public static final java.lang.String CURRENT_QUERY
See Also:
Constant Field Values

CURRENT_MITLIST_ID

public static final java.lang.String CURRENT_MITLIST_ID
See Also:
Constant Field Values

CURRENT_MITLISTITEM

public static final java.lang.String CURRENT_MITLISTITEM
See Also:
Constant Field Values

USER_SELECTED_MODULE

public static final java.lang.String USER_SELECTED_MODULE
See Also:
Constant Field Values

PROJECT_CHANGE_BOX

public static final java.lang.String PROJECT_CHANGE_BOX
Deprecated. No longer used

See Also:
Constant Field Values

THREAD_QUERY_KEY

public static final java.lang.String THREAD_QUERY_KEY
See Also:
Constant Field Values

REMOVE_CURRENT_MITLIST_QKEY

public static final java.lang.String REMOVE_CURRENT_MITLIST_QKEY
See Also:
Constant Field Values

INSTANCE_ID

public static final java.lang.String INSTANCE_ID
This name will be used to distinguish specific scarab application from other instances that it may interact with (in the future). It is the prefix to all issue id's created in response to an issue entered against a module in this instance's database.

See Also:
Constant Field Values

MAX_WORD_RATING

public static final int MAX_WORD_RATING
This is maximum rating for a word.

See Also:
Constant Field Values

ISSUE_ID_LIST

public static final java.lang.String ISSUE_ID_LIST
The list of issue id's resulting from a search.

See Also:
Constant Field Values

NO_PERMISSION_MESSAGE

public static final java.lang.String NO_PERMISSION_MESSAGE
The message the user sees if they try to perform an action For which they have no permissions.

See Also:
Constant Field Values

ATTACHMENTS_REPO_KEY

public static final java.lang.String ATTACHMENTS_REPO_KEY
See Also:
Constant Field Values

ARCHIVE_EMAIL_ADDRESS

public static final java.lang.String ARCHIVE_EMAIL_ADDRESS
See Also:
Constant Field Values

IMPORT_ADD_USERS

public static final java.lang.String IMPORT_ADD_USERS
See Also:
Constant Field Values

DROPDOWN_LIST

public static final java.lang.String DROPDOWN_LIST
An attribute type

See Also:
Constant Field Values

AUTO_APPROVED_ROLES

public static final java.lang.String AUTO_APPROVED_ROLES
Scarab.properties key for roles to be automatically approved.

See Also:
Constant Field Values

SINGLE_SCREEN_ONLY

public static final java.lang.String SINGLE_SCREEN_ONLY
Scarab.properties key for restricting viewIssue to long form (single screen).

See Also:
Constant Field Values

TAB_KEY

public static final java.lang.String TAB_KEY
key used to store session preference for long issue view vs. tabs used in get/setTemp within ScarabUser.

See Also:
Constant Field Values

ISSUE_VIEW_ALL

public static final java.lang.String ISSUE_VIEW_ALL
Value of the session parameter to view the issue in long form.

See Also:
Constant Field Values

INVALID_SEARCH_CHARACTERS

public static final java.lang.String INVALID_SEARCH_CHARACTERS
list of invalid characters when doing searches

See Also:
Constant Field Values

DATE_FORMAT

public static final java.lang.String DATE_FORMAT
format for displaying dates

See Also:
Constant Field Values

ISO_DATE_PATTERN

public static final java.lang.String ISO_DATE_PATTERN
The ISO date format that we accept when users enter dates.

See Also:
Constant Field Values

ISO_DATETIME_PATTERN

public static final java.lang.String ISO_DATETIME_PATTERN
The ISO date/time format that we accept when users enter dates and times.

See Also:
Constant Field Values

DEFAULT_BUNDLE_NAME

public static final java.lang.String DEFAULT_BUNDLE_NAME
The default base for resolving ResourceBundles.

See Also:
Constant Field Values

DEFAULT_LOCALE

public static final java.util.Locale DEFAULT_LOCALE
Default locale, taken from configuration files.


DEFAULT_EMAIL_ENCODING_KEY

public static final java.lang.String DEFAULT_EMAIL_ENCODING_KEY
Scarab.properties key for email encoding property.

See Also:
Constant Field Values

INTEGER_0

public static final java.lang.Integer INTEGER_0

QUERY_MAX_FILTER_CRITERIA

public static final int QUERY_MAX_FILTER_CRITERIA
See Also:
Constant Field Values

QUERY_MAX_JOIN

public static final int QUERY_MAX_JOIN
See Also:
Constant Field Values

ISSUE_MAX_VIEW

public static final int ISSUE_MAX_VIEW
The maximum number of issues for batch view of detail.


ISSUE_MAX_ASSIGN

public static final int ISSUE_MAX_ASSIGN
The maximum number of issues for batch assign.


ISSUE_MAX_COPY

public static final int ISSUE_MAX_COPY
The maximum number of issues for batch copy.


ISSUE_MAX_MOVE

public static final int ISSUE_MAX_MOVE
The maximum number of issues for batch move.


REPORT_MAX_CRITERIA

public static final int REPORT_MAX_CRITERIA
The maximumn number of report headings


COMMENT_RENDER_ENGINE

public static final java.lang.String COMMENT_RENDER_ENGINE
The default comment rendering engine


HTTP_DOMAIN

public static final java.lang.String HTTP_DOMAIN
See Also:
Constant Field Values

HTTP_SCHEME

public static final java.lang.String HTTP_SCHEME
See Also:
Constant Field Values

HTTP_SCRIPT_NAME

public static final java.lang.String HTTP_SCRIPT_NAME
See Also:
Constant Field Values

HTTP_PORT

public static final java.lang.String HTTP_PORT
See Also:
Constant Field Values

TRANSITION_OBJECT

public static final int TRANSITION_OBJECT
See Also:
Constant Field Values

GLOBAL_ATTRIBUTE_OBJECT

public static final int GLOBAL_ATTRIBUTE_OBJECT
See Also:
Constant Field Values

MODULE_ATTRIBUTE_OBJECT

public static final int MODULE_ATTRIBUTE_OBJECT
See Also:
Constant Field Values

BLOCKED_MODULE_ISSUE_TYPE_OBJECT

public static final int BLOCKED_MODULE_ISSUE_TYPE_OBJECT
See Also:
Constant Field Values

IS_BLOCKED

public static final java.lang.String IS_BLOCKED
See Also:
Constant Field Values

BLOCKS

public static final java.lang.String BLOCKS
See Also:
Constant Field Values


Copyright © 2000-2004 Tigris.org. All Rights Reserved.