com.basis.api.admin

Interface BBjAdminBuiApplication

All Superinterfaces:

BBjAdminCommitPropertyWriter, BBjAdminCommitWriter, BBjAdminPropertyReader, BBjAdminPropertyWriter, java.lang.Comparable<BBjAdminBuiApplication>, java.rmi.Remote

public interface BBjAdminBuiApplication
extends BBjAdminCommitPropertyWriter, java.lang.Comparable<BBjAdminBuiApplication>

Configuration for the BUI application on the server.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	APPLICATION_USER
static java.lang.String	CLASSPATH
static java.lang.String	CLIENT_RESPONSE_TIMEOUT
static java.lang.String	CLIENT_RESPONSE_TIMEOUT_USE_DEFAULT
static java.lang.String	CONFIG_FILE
static java.lang.String	CONTEXT
static java.lang.String	CSS_RESOURCE_ID
static java.lang.String	DEVELOPMENT_MODE
static java.lang.String	DEVELOPMENT_MODE_USE_DEFAULT
static java.lang.String	DISALLOW_CONSOLE
static java.lang.String	DISALLOW_CONSOLE_USE_DEFAULT
static java.lang.String	LOAD_IMAGE_RESOURCE_ID
static java.lang.String	MANAGE_BROWSER_HISTORY
static java.lang.String	MANAGE_BROWSER_HISTORY_USE_DEFAULT
static java.lang.String	NAME
static java.lang.String	OMIT_BASIS_CSS
static java.lang.String	OMIT_BASIS_CSS_USE_DEFAULT
static java.lang.String	PROGRAM
static java.lang.String	QUIET
static java.lang.String	SECURE
static java.lang.String	SECURE_USE_DEFAULT
static java.lang.String	SHORTCUT_ICON_RESOURCE_ID
static java.lang.String	SHOW_BROWSER_WARNING
static java.lang.String	SHOW_BROWSER_WARNING_USE_DEFAULT
static java.lang.String	SHOW_CONFIRM_CLOSE_DIALOG
static java.lang.String	SHOW_CONFIRM_CLOSE_DIALOG_USE_DEFAULT
static java.lang.String	TERMINAL
static java.lang.String	WORKING_DIRECTORY

Method Summary

Modifier and Type	Method and Description
BBjAdminList<java.lang.String>	getArguments() Returns the list of the program arguments for this application.
BBjAdminList<BBjAdminProperty>	getDescriptiveProperties() Used primarily by GUI applications like the Enterprise Manager to dynamically generate an admin UI.
java.lang.String	getUrl() Generates and returns a URL for the application that can be used to run the application from a Web browser.
void	setDescriptiveProperties(BBjAdminList<BBjAdminProperty> p_descriptiveProps) Used primarily by GUI applications like the Enterprise Manager to dynamically generate an admin UI.

Methods inherited from interface com.basis.api.admin.BBjAdminCommitPropertyWriter

getChangedProperties, getClearedProperties, getOriginalProperties

Methods inherited from interface com.basis.api.admin.BBjAdminPropertyWriter

addType, canAddNewProperties, canClear, clear, clearProperties, clearProperty, getReadOnly, hasChanged, isReadOnly, setBoolean, setDouble, setInt, setList, setLong, setProperties, setString, setValue

Methods inherited from interface com.basis.api.admin.BBjAdminPropertyReader

checkValueEqual, contains, contains, getBoolean, getDouble, getInt, getList, getLong, getProperties, getString, getType, getTypes, getValue

Methods inherited from interface com.basis.api.admin.BBjAdminCommitWriter

commit, rollback

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

APPLICATION_USER

static final java.lang.String APPLICATION_USER

See Also:

Constant Field Values

CLASSPATH

static final java.lang.String CLASSPATH

See Also:

Constant Field Values

CLIENT_RESPONSE_TIMEOUT

static final java.lang.String CLIENT_RESPONSE_TIMEOUT

See Also:

Constant Field Values

CLIENT_RESPONSE_TIMEOUT_USE_DEFAULT

static final java.lang.String CLIENT_RESPONSE_TIMEOUT_USE_DEFAULT

See Also:

Constant Field Values

CONFIG_FILE

static final java.lang.String CONFIG_FILE

See Also:

Constant Field Values

CONTEXT

static final java.lang.String CONTEXT

See Also:

Constant Field Values

CSS_RESOURCE_ID

static final java.lang.String CSS_RESOURCE_ID

See Also:

Constant Field Values

DEVELOPMENT_MODE

static final java.lang.String DEVELOPMENT_MODE

See Also:

Constant Field Values

DEVELOPMENT_MODE_USE_DEFAULT

static final java.lang.String DEVELOPMENT_MODE_USE_DEFAULT

See Also:

Constant Field Values

DISALLOW_CONSOLE

static final java.lang.String DISALLOW_CONSOLE

See Also:

Constant Field Values

DISALLOW_CONSOLE_USE_DEFAULT

static final java.lang.String DISALLOW_CONSOLE_USE_DEFAULT

See Also:

Constant Field Values

LOAD_IMAGE_RESOURCE_ID

static final java.lang.String LOAD_IMAGE_RESOURCE_ID

See Also:

Constant Field Values

MANAGE_BROWSER_HISTORY

static final java.lang.String MANAGE_BROWSER_HISTORY

See Also:

Constant Field Values

MANAGE_BROWSER_HISTORY_USE_DEFAULT

static final java.lang.String MANAGE_BROWSER_HISTORY_USE_DEFAULT

See Also:

Constant Field Values

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

OMIT_BASIS_CSS

static final java.lang.String OMIT_BASIS_CSS

See Also:

Constant Field Values

OMIT_BASIS_CSS_USE_DEFAULT

static final java.lang.String OMIT_BASIS_CSS_USE_DEFAULT

See Also:

Constant Field Values

PROGRAM

static final java.lang.String PROGRAM

See Also:

Constant Field Values

QUIET

static final java.lang.String QUIET

See Also:

Constant Field Values

SECURE

static final java.lang.String SECURE

See Also:

Constant Field Values

SECURE_USE_DEFAULT

static final java.lang.String SECURE_USE_DEFAULT

See Also:

Constant Field Values

SHORTCUT_ICON_RESOURCE_ID

static final java.lang.String SHORTCUT_ICON_RESOURCE_ID

See Also:

Constant Field Values

SHOW_BROWSER_WARNING

static final java.lang.String SHOW_BROWSER_WARNING

See Also:

Constant Field Values

SHOW_BROWSER_WARNING_USE_DEFAULT

static final java.lang.String SHOW_BROWSER_WARNING_USE_DEFAULT

See Also:

Constant Field Values

SHOW_CONFIRM_CLOSE_DIALOG

static final java.lang.String SHOW_CONFIRM_CLOSE_DIALOG

See Also:

Constant Field Values

SHOW_CONFIRM_CLOSE_DIALOG_USE_DEFAULT

static final java.lang.String SHOW_CONFIRM_CLOSE_DIALOG_USE_DEFAULT

See Also:

Constant Field Values

TERMINAL

static final java.lang.String TERMINAL

See Also:

Constant Field Values

WORKING_DIRECTORY

static final java.lang.String WORKING_DIRECTORY

See Also:

Constant Field Values

Method Detail

getArguments

BBjAdminList<java.lang.String> getArguments()
                                     throws BBjAdminException

Returns the list of the program arguments for this application.

Returns:

list of the program arguments.

Throws:

BBjAdminException

getDescriptiveProperties

BBjAdminList<BBjAdminProperty> getDescriptiveProperties()
                                                 throws BBjAdminException

Used primarily by GUI applications like the Enterprise Manager to dynamically generate an admin UI. To get property values for general purposes, you should call the getXXX() methods.

Returns:

BBjAdminList containing BBjAdminProperty objects for each available property.

Throws:

BBjAdminException

getUrl

java.lang.String getUrl()
                 throws BBjAdminException

Generates and returns a URL for the application that can be used to run the application from a Web browser. It uses the name in combination with the host and port information from the Jetty server.

Returns:

Application URL.

Throws:

BBjAdminException

setDescriptiveProperties

void setDescriptiveProperties(BBjAdminList<BBjAdminProperty> p_descriptiveProps)
                       throws BBjAdminException

Used primarily by GUI applications like the Enterprise Manager to dynamically generate an admin UI. To set property values for general purposes, you should call the setXXX() methods.

Throws:

BBjAdminException