planetj.dataengine
Interface IDataEngine

All Superinterfaces:

IApplicationJSPs, IJSPPages, INavigation, IServletParameters, IWOWJSPs

All Known Implementing Classes:

DataEngine, DataEngineManager, DataEngineServlet, FDManagerApplication, SessionManager

public interface IDataEngine

extends INavigation, IServletParameters, IJSPPages

DataEngine Constants

Field Summary

static String	ACTION Variable to retrieve an input parameter from the HttpServletRequest in order to determine what action to carry out.
static String	ADMIN_MAGIC_REQUEST
static List	ALL_SERVLET_PATHS
static String	ALLOW_MULTIPLE_DELETES
static String	ALLOW_MULTIPLE_SELECTION
static String	APPLICATION
static String	COMPANY
static String	CONTEXT
static String	CONTEXT_KEY
static String	CONTROLLER_SERVLET_PATH
static String	CONTROLLER_SERVLET_URI
static String	CURRENT_SQL_CONTEXT
static String	CURRENT_SQL_RECORD_COUNT
static String	CURRENT_SQL_STRING
static String	CURRENT_TOC
static String	DATA_ENGINE_MESSAGE Deprecated. should use ERROR_MESSAGE instead for naming purposes
static String	DATAENGINE_ADMIN_SERVLET_PATH
static String	DATAENGINE_APPLICATION_BUILDER_SERVLET_PATH
static String	DATAENGINE_APPLICATION_SERVLET_PATH
static String	DATAEXPLORER_SERVLET_PATH
static String	DE_ACTION_CATEGORY Variable to retrieve an input parameter from the HttpServletRequest in order to determine what category the action to carry out belongs to.
static String	DE_ACTION_SIGN_ON
static String	DEFAULT_LAYOUT_DISPLAY_PROPERTIES Deprecated. replaced with LayoutProperties.className
static String	DEFAULT_RESULTS_KEY
static String	DEFAULT_USER_LIBRARY
static String	DETAILS
static String	EDITABLE_OPERATIONS Key for boolean indicating if the applications operations can be edited
static String	ENVIRONMENT_MODE_DEVELOPMENT
static String	ENVIRONMENT_MODE_PRODUCTION
static int	ERROR_APPLICATION_INVALID
static int	ERROR_COMPANY_INVALID
static String	ERROR_MESSAGE Error message constant used for JSP feedback with errors to the user
static String	EXCEPTION Throwable constant used for putting storing an exception in the request.
static String	EXCEPTION_JSP_KEY
static String	FIELD
static String	FIELD_DESCRIPTOR_SERVLET_PATH
static String	FIELD_LIST
static String	FIELD_NAMES
static String	FIELDS
static String	FORM_LIB_TBL_FLD
static String	FUNCTION
static String	HIDDEN_APPLICATION_ID Key used for generating and extracting the hidden application id appended to each page.
static String	HIDDEN_APPLICATION_METADATA_ALIAS Key used for generating and extracting the hidden metadata alias for the current application on each page.
static String	IGNORE_MAGIC_REQUEST
static String	KEEP_INSERT_VALUES
static String	LAST_JSP_CALLED
static String	LAUNCHED_FROM_BUILDER Key for boolean indicating if the application was launched from the builder
static String	LIBRARY
static String	LIBRARY_LIST
static String	MAGIC_ACTION_ROW
static String	MODE
static String	MODE_COPY
static String	MODE_DELETE
static String	MODE_EDIT
static String	MODE_INSERT
static String	MODE_SEARCH
static String	MODE_UNKNOWN
static String	MODE_VIEW
static int	MULTIPLESELECTION
static String	NEW_ROW
static String	NEW_WINDOW_FOR_RESULTS
static String	NEXT_PAGE
static int	NOSELECTION
static String	OPERATION
static String	OPERATION_KEY
static String	OWNER_ID
static String	PAGE
static String	PAGE_REQUEST_EXECUTED
static String	PAGE_VALIDATION_REQUIRED
static String	PARAMETER_VALUE_PREFIX
static String	PREVIOUS_PAGE
static List	RESERVED_PARAMETERS
static String	RETRIEVE_ALL_COLUMNS_ON_COPY
static String	RETRIEVE_ALL_COLUMNS_ON_EDIT
static String	RETRIEVE_ALL_COLUMNS_ON_VIEW
static String	RETRIEVE_FIELDS
static String	RETRIEVE_TABLES
static String	RETURN_URI The URI to return to after executing a MagicRequest.
static String	ROW
static String	ROW_ALTERNATE_KEY
static String	ROW_COLLECTION
static String	ROW_COLLECTION_KEY
static String	ROW_KEY
static String	ROW_KEY_FOR_DETAILS
static String	ROW_SELECTION_JS_INCLUDED Id to check if JavaScript used for Row selection is already included
static String	ROWS_ALTERED_COUNT Number of rows altered by the last magic request
static String	SELECTED_ROW Id for Row selected in request
static String	SELECTED_ROW_COLLECTION Id for RowCollection selected in request
static String	SELECTEDOBJECTS
static String	SERVLET_CONTEXT
static String	SESSION_RANDOM_NUMBER
static String	SESSION_SIGNED_OFF
static String	SESSION_SIGNON_RECEIPT_KEY
static String	SESSION_TIMED_OUT Key used to check the request if the user's session timed out.
static String	SHOW_FD_QUICK_LINKS
static String	SHOW_UPDATABLE_TABLES
static String	SHOW_UPDATEABLE_ROW Used to put in the HttpServletRequest to allow the default_row_details.jsp to determine whether or not it should show the Row's Fields as inputs.
static String	SIGN_ON_CALLER
static String	SIGNON
static String	SIGNON_AND_REGISTRATION_SERVLET_PATH
static int	SINGLESELECTION
static String	STATEMENT
static String	SYSTEM
static String	SYSTEMS_LIST
static String	TABLE
static String	TABLE_LIST
static String	TRANSIENT
static String	UNSUPPORTED
static String	USER_LIBRARY_HTTP_PARAMETER
static String	USER_LIBRARY_HTTP_SESSION_KEY
static String	USER_MESSAGE User message constants used for JSP feedback to the user
static String	USER_PREFERENCES Deprecated. replaced with UserProperties.className
static int	VALID_SIGNON
static byte	WINDOW_CLOSE Immediately close the current window
static byte	WINDOW_NORMAL No special behavior for the current window
static byte	WINDOW_POPUP Do not display a header, TOC, or footer in the current window.
static String	WINDOW_TYPE_PARAM

Fields inherited from interface planetj.dataengine.INavigation

CHILD_PREFIX, GROUP_ATTRIBUTES, GROUP_ID, INITIAL_GROUP_ID, INITIAL_PAGE_ID, INITIAL_REQUEST_ID, NAVIGATION_CHECKED, NAVIGATION_OBJECT_LIST_PREFIX, NEW_GROUP_ID, NEW_REQUEST_ID, NEW_SESSION_ID, PAGE_ATTRIBUTES, PAGE_ID, PARENT_PREFIX, PERSISTENT_ATTRIBUTES, PREVIOUS_ATTRIBUTES, PREVIOUS_GROUP_ID, PREVIOUS_PAGE_ID, PREVIOUS_REQUEST_ID, REQUEST_ID, RESET_GROUP_ID, RESET_NAVIGATION_IDS, RESET_NAVIGATION_IDS_COMPLETED, RESET_PAGE_ID, RESET_REQUEST_ID, RESET_SESSION_ID, SESSION_ID

Fields inherited from interface planetj.dataengine.IServletParameters

ALL, AUTO_RUN, BASE_URL, CACHE_TRACK_ON, CACHE_TRACK_WRITE_TO_FILE, CLEAN_UP_TIME, DATABASE, DRIVER, ENVIRONMENT_MODE, JDBC_OPTIMIZATIONS, MAX_CONNECTIONS, METADATA_LIBRARY, MIN_CONNECTIONS, ORPHAN_TIMEOUT, PASSWORD, PORT, SYSTEM_ALIAS, SYSTEM_ALIAS_PARAM, SYSTEM_URL, USER_ID, USER_PASSWORD

Fields inherited from interface planetj.dataengine.IJSPPages

CUSTOM_LOG_ON_JSP, DEFAULT_ADD_BODY_JSP, DEFAULT_EDIT_BODY_JSP, DEFAULT_PARAMS_JSP, DEFAULT_PRINT_PAGE_JSP, DEFAULT_RESULTS_JSP, DEFAULT_ROW_DETAILS, DEFAULT_SQL_OPERATION_RESULTS_JSP, DEFAULT_VIEW_BODY_JSP, DETAILS_JSP, DISPLAY_EXCEPTION_JSP, INITIAL_JSP, SIGN_ON_BODY_JSP, SIGN_ON_JSP, SIGNON_PARAMS_JSP

Fields inherited from interface planetj.dataengine.application.IApplicationJSPs

APPLICATION_ADD_JSP, APPLICATION_DETAILS_JSP, APPLICATION_EDIT_JSP, APPLICATION_ERROR_JSP, APPLICATION_HEADER_JSP, APPLICATION_INVALID_LICENSE_JSP, APPLICATION_JSP, APPLICATION_MESSAGE_JSP, APPLICATION_OPERATIONS_TOC, APPLICATION_RESULTS_JSP, APPLICATION_SIGN_ON_JSP, APPLICATION_TEMPLATE_JSP, APPLICATION_TOC_JSP, APPLICATION_VIEW_JSP

Fields inherited from interface planetj.dataengine.application.IWOWJSPs

WOW_MAIN_EXCEPTION_JSP, WOW_MANAGE_OPERATIONS_JSP, WOW_STEPS_JSP, WOW_TOC, WOW_VIEW_APPLICATIONS_JSP, WOW_VIEW_CONNECTIONS_JSP

Field Detail

HIDDEN_APPLICATION_ID

public static final String HIDDEN_APPLICATION_ID

Key used for generating and extracting the hidden application id appended to each page.

See Also:

Constant Field Values

HIDDEN_APPLICATION_METADATA_ALIAS

public static final String HIDDEN_APPLICATION_METADATA_ALIAS

Key used for generating and extracting the hidden metadata alias for the current application on each page.

See Also:

Constant Field Values

SESSION_TIMED_OUT

public static final String SESSION_TIMED_OUT

Key used to check the request if the user's session timed out.

See Also:

Constant Field Values

SESSION_SIGNED_OFF

public static final String SESSION_SIGNED_OFF

See Also:

Constant Field Values

PAGE_VALIDATION_REQUIRED

public static final String PAGE_VALIDATION_REQUIRED

See Also:

Constant Field Values

SELECTED_ROW_COLLECTION

public static final String SELECTED_ROW_COLLECTION

Id for RowCollection selected in request

See Also:

Constant Field Values

SELECTED_ROW

public static final String SELECTED_ROW

Id for Row selected in request

See Also:

Constant Field Values

ROW_SELECTION_JS_INCLUDED

public static final String ROW_SELECTION_JS_INCLUDED

Id to check if JavaScript used for Row selection is already included

See Also:

Constant Field Values

ACTION

public static final String ACTION

Variable to retrieve an input parameter from the HttpServletRequest in order to determine what action to carry out. (see DETemplateServlet for an example use)

See Also:

Constant Field Values

DE_ACTION_SIGN_ON

public static final String DE_ACTION_SIGN_ON

See Also:

Constant Field Values

DE_ACTION_CATEGORY

public static final String DE_ACTION_CATEGORY

Variable to retrieve an input parameter from the HttpServletRequest in order to determine what category the action to carry out belongs to. (see DETemplateServlet for an example use) (Allows actions to be grouped)

See Also:

Constant Field Values

PARAMETER_VALUE_PREFIX

public static final String PARAMETER_VALUE_PREFIX

See Also:

Constant Field Values

NOSELECTION

public static final int NOSELECTION

See Also:

Constant Field Values

SINGLESELECTION

public static final int SINGLESELECTION

See Also:

Constant Field Values

MULTIPLESELECTION

public static final int MULTIPLESELECTION

See Also:

Constant Field Values

FORM_LIB_TBL_FLD

public static final String FORM_LIB_TBL_FLD

See Also:

Constant Field Values

FIELDS

public static final String FIELDS

See Also:

Constant Field Values

STATEMENT

public static final String STATEMENT

See Also:

Constant Field Values

TRANSIENT

public static final String TRANSIENT

See Also:

Constant Field Values

PAGE_REQUEST_EXECUTED

public static final String PAGE_REQUEST_EXECUTED

See Also:

Constant Field Values

PREVIOUS_PAGE

public static final String PREVIOUS_PAGE

See Also:

Constant Field Values

NEXT_PAGE

public static final String NEXT_PAGE

See Also:

Constant Field Values

PAGE

public static final String PAGE

See Also:

Constant Field Values

NEW_ROW

public static final String NEW_ROW

See Also:

Constant Field Values

IGNORE_MAGIC_REQUEST

public static final String IGNORE_MAGIC_REQUEST

See Also:

Constant Field Values

CURRENT_TOC

public static final String CURRENT_TOC

See Also:

Constant Field Values

UNSUPPORTED

public static final String UNSUPPORTED

See Also:

Constant Field Values

SYSTEM

public static final String SYSTEM

See Also:

Constant Field Values

SYSTEMS_LIST

public static final String SYSTEMS_LIST

See Also:

Constant Field Values

LIBRARY

public static final String LIBRARY

See Also:

Constant Field Values

LIBRARY_LIST

public static final String LIBRARY_LIST

See Also:

Constant Field Values

TABLE

public static final String TABLE

See Also:

Constant Field Values

TABLE_LIST

public static final String TABLE_LIST

See Also:

Constant Field Values

FIELD

public static final String FIELD

See Also:

Constant Field Values

FIELD_LIST

public static final String FIELD_LIST

See Also:

Constant Field Values

FIELD_NAMES

public static final String FIELD_NAMES

See Also:

Constant Field Values

CURRENT_SQL_STRING

public static final String CURRENT_SQL_STRING

See Also:

Constant Field Values

CURRENT_SQL_RECORD_COUNT

public static final String CURRENT_SQL_RECORD_COUNT

See Also:

Constant Field Values

COMPANY

public static final String COMPANY

See Also:

Constant Field Values

APPLICATION

public static final String APPLICATION

See Also:

Constant Field Values

SIGNON

public static final String SIGNON

See Also:

Constant Field Values

DETAILS

public static final String DETAILS

See Also:

Constant Field Values

FUNCTION

public static final String FUNCTION

See Also:

Constant Field Values

RETRIEVE_TABLES

public static final String RETRIEVE_TABLES

See Also:

Constant Field Values

RETRIEVE_FIELDS

public static final String RETRIEVE_FIELDS

See Also:

Constant Field Values

VALID_SIGNON

public static final int VALID_SIGNON

See Also:

Constant Field Values

ERROR_COMPANY_INVALID

public static final int ERROR_COMPANY_INVALID

See Also:

Constant Field Values

ERROR_APPLICATION_INVALID

public static final int ERROR_APPLICATION_INVALID

See Also:

Constant Field Values

SELECTEDOBJECTS

public static final String SELECTEDOBJECTS

See Also:

Constant Field Values

SHOW_UPDATEABLE_ROW

public static final String SHOW_UPDATEABLE_ROW

Used to put in the HttpServletRequest to allow the default_row_details.jsp to determine whether or not it should show the Row's Fields as inputs.

See Also:

Constant Field Values

USER_MESSAGE

public static final String USER_MESSAGE

User message constants used for JSP feedback to the user

See Also:

Constant Field Values

ERROR_MESSAGE

public static final String ERROR_MESSAGE

Error message constant used for JSP feedback with errors to the user

See Also:

Constant Field Values

EXCEPTION

public static final String EXCEPTION

Throwable constant used for putting storing an exception in the request.

See Also:

Constant Field Values

CONTROLLER_SERVLET_URI

public static final String CONTROLLER_SERVLET_URI

See Also:

Constant Field Values

CONTROLLER_SERVLET_PATH

public static final String CONTROLLER_SERVLET_PATH

See Also:

Constant Field Values

ADMIN_MAGIC_REQUEST

public static final String ADMIN_MAGIC_REQUEST

See Also:

Constant Field Values

LAST_JSP_CALLED

public static final String LAST_JSP_CALLED

See Also:

Constant Field Values

DATA_ENGINE_MESSAGE

public static final String DATA_ENGINE_MESSAGE

Deprecated. should use ERROR_MESSAGE instead for naming purposes

See Also:

Constant Field Values

USER_PREFERENCES

public static final String USER_PREFERENCES

Deprecated. replaced with UserProperties.className

ALLOW_MULTIPLE_SELECTION

public static final String ALLOW_MULTIPLE_SELECTION

See Also:

Constant Field Values

ALLOW_MULTIPLE_DELETES

public static final String ALLOW_MULTIPLE_DELETES

See Also:

Constant Field Values

SHOW_UPDATABLE_TABLES

public static final String SHOW_UPDATABLE_TABLES

See Also:

Constant Field Values

NEW_WINDOW_FOR_RESULTS

public static final String NEW_WINDOW_FOR_RESULTS

See Also:

Constant Field Values

KEEP_INSERT_VALUES

public static final String KEEP_INSERT_VALUES

See Also:

Constant Field Values

SHOW_FD_QUICK_LINKS

public static final String SHOW_FD_QUICK_LINKS

See Also:

Constant Field Values

RETRIEVE_ALL_COLUMNS_ON_EDIT

public static final String RETRIEVE_ALL_COLUMNS_ON_EDIT

See Also:

Constant Field Values

RETRIEVE_ALL_COLUMNS_ON_COPY

public static final String RETRIEVE_ALL_COLUMNS_ON_COPY

See Also:

Constant Field Values

RETRIEVE_ALL_COLUMNS_ON_VIEW

public static final String RETRIEVE_ALL_COLUMNS_ON_VIEW

See Also:

Constant Field Values

SIGN_ON_CALLER

public static final String SIGN_ON_CALLER

See Also:

Constant Field Values

MODE

public static final String MODE

See Also:

Constant Field Values

MODE_UNKNOWN

public static final String MODE_UNKNOWN

See Also:

Constant Field Values

MODE_VIEW

public static final String MODE_VIEW

See Also:

Constant Field Values

MODE_EDIT

public static final String MODE_EDIT

See Also:

Constant Field Values

MODE_INSERT

public static final String MODE_INSERT

See Also:

Constant Field Values

MODE_DELETE

public static final String MODE_DELETE

See Also:

Constant Field Values

MODE_COPY

public static final String MODE_COPY

See Also:

Constant Field Values

MODE_SEARCH

public static final String MODE_SEARCH

See Also:

Constant Field Values

ENVIRONMENT_MODE_PRODUCTION

public static final String ENVIRONMENT_MODE_PRODUCTION

See Also:

Constant Field Values

ENVIRONMENT_MODE_DEVELOPMENT

public static final String ENVIRONMENT_MODE_DEVELOPMENT

See Also:

Constant Field Values

DEFAULT_RESULTS_KEY

public static final String DEFAULT_RESULTS_KEY

See Also:

Constant Field Values

DEFAULT_LAYOUT_DISPLAY_PROPERTIES

public static final String DEFAULT_LAYOUT_DISPLAY_PROPERTIES

Deprecated. replaced with LayoutProperties.className

DATAEXPLORER_SERVLET_PATH

public static final String DATAEXPLORER_SERVLET_PATH

See Also:

Constant Field Values

DATAENGINE_APPLICATION_BUILDER_SERVLET_PATH

public static final String DATAENGINE_APPLICATION_BUILDER_SERVLET_PATH

See Also:

Constant Field Values

DATAENGINE_APPLICATION_SERVLET_PATH

public static final String DATAENGINE_APPLICATION_SERVLET_PATH

See Also:

Constant Field Values

SIGNON_AND_REGISTRATION_SERVLET_PATH

public static final String SIGNON_AND_REGISTRATION_SERVLET_PATH

See Also:

Constant Field Values

FIELD_DESCRIPTOR_SERVLET_PATH

public static final String FIELD_DESCRIPTOR_SERVLET_PATH

See Also:

Constant Field Values

DATAENGINE_ADMIN_SERVLET_PATH

public static final String DATAENGINE_ADMIN_SERVLET_PATH

See Also:

Constant Field Values

ALL_SERVLET_PATHS

public static final List ALL_SERVLET_PATHS

SERVLET_CONTEXT

public static final String SERVLET_CONTEXT

See Also:

Constant Field Values

RETURN_URI

public static final String RETURN_URI

The URI to return to after executing a MagicRequest.

See Also:

Constant Field Values

ROW_KEY

public static final String ROW_KEY

See Also:

Constant Field Values

ROW_ALTERNATE_KEY

public static final String ROW_ALTERNATE_KEY

See Also:

Constant Field Values

ROW_KEY_FOR_DETAILS

public static final String ROW_KEY_FOR_DETAILS

See Also:

Constant Field Values

ROW_COLLECTION_KEY

public static final String ROW_COLLECTION_KEY

See Also:

Constant Field Values

CONTEXT_KEY

public static final String CONTEXT_KEY

See Also:

Constant Field Values

OPERATION_KEY

public static final String OPERATION_KEY

See Also:

Constant Field Values

ROW_COLLECTION

public static final String ROW_COLLECTION

ROW

public static final String ROW

MAGIC_ACTION_ROW

public static final String MAGIC_ACTION_ROW

See Also:

Constant Field Values

CONTEXT

public static final String CONTEXT

OPERATION

public static final String OPERATION

CURRENT_SQL_CONTEXT

public static final String CURRENT_SQL_CONTEXT

OWNER_ID

public static final String OWNER_ID

EXCEPTION_JSP_KEY

public static final String EXCEPTION_JSP_KEY

See Also:

Constant Field Values

SESSION_SIGNON_RECEIPT_KEY

public static final String SESSION_SIGNON_RECEIPT_KEY

See Also:

Constant Field Values

DEFAULT_USER_LIBRARY

public static final String DEFAULT_USER_LIBRARY

See Also:

Constant Field Values

USER_LIBRARY_HTTP_PARAMETER

public static final String USER_LIBRARY_HTTP_PARAMETER

See Also:

Constant Field Values

USER_LIBRARY_HTTP_SESSION_KEY

public static final String USER_LIBRARY_HTTP_SESSION_KEY

See Also:

Constant Field Values

WINDOW_TYPE_PARAM

public static final String WINDOW_TYPE_PARAM

See Also:

Constant Field Values

WINDOW_CLOSE

public static final byte WINDOW_CLOSE

Immediately close the current window

See Also:

Constant Field Values

WINDOW_NORMAL

public static final byte WINDOW_NORMAL

No special behavior for the current window

See Also:

Constant Field Values

WINDOW_POPUP

public static final byte WINDOW_POPUP

Do not display a header, TOC, or footer in the current window. In addition, the current window will be closed when the current task is completed

See Also:

Constant Field Values

ROWS_ALTERED_COUNT

public static final String ROWS_ALTERED_COUNT

Number of rows altered by the last magic request

See Also:

Constant Field Values

RESERVED_PARAMETERS

public static final List RESERVED_PARAMETERS

EDITABLE_OPERATIONS

public static final String EDITABLE_OPERATIONS

Key for boolean indicating if the applications operations can be edited

See Also:

Constant Field Values

LAUNCHED_FROM_BUILDER

public static final String LAUNCHED_FROM_BUILDER

Key for boolean indicating if the application was launched from the builder

See Also:

Constant Field Values

SESSION_RANDOM_NUMBER

public static final String SESSION_RANDOM_NUMBER

See Also:

Constant Field Values