Package com.basis.api.admin

Interface BBjAdminBuiApplication

All Superinterfaces:

BBjAdminCommitPropertyWriter, BBjAdminCommitWriter, BBjAdminPropertyReader, BBjAdminPropertyWriter, Comparable<BBjAdminBuiApplication>, Remote

public interface BBjAdminBuiApplication
extends BBjAdminCommitPropertyWriter, Comparable<BBjAdminBuiApplication>

Configuration for the BUI application on the server.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
BBjAdminList<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.
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.BBjAdminCommitWriter

commit, rollback

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.BBjAdminPropertyWriter

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

Methods inherited from interface java.lang.Comparable

compareTo

Field Details

APPLICATION_USER

static final String APPLICATION_USER

See Also:

• Constant Field Values

CLASSPATH

static final String CLASSPATH

See Also:

• Constant Field Values

CLIENT_RESPONSE_TIMEOUT

static final String CLIENT_RESPONSE_TIMEOUT

See Also:

• Constant Field Values

CLIENT_RESPONSE_TIMEOUT_USE_DEFAULT

static final String CLIENT_RESPONSE_TIMEOUT_USE_DEFAULT

See Also:

• Constant Field Values

CONFIG_FILE

static final String CONFIG_FILE

See Also:

• Constant Field Values

CONTEXT

static final String CONTEXT

See Also:

• Constant Field Values

CSS_RESOURCE_ID

static final String CSS_RESOURCE_ID

See Also:

• Constant Field Values

DEVELOPMENT_MODE

static final String DEVELOPMENT_MODE

See Also:

• Constant Field Values

DEVELOPMENT_MODE_USE_DEFAULT

static final String DEVELOPMENT_MODE_USE_DEFAULT

See Also:

• Constant Field Values

DISALLOW_CONSOLE

static final String DISALLOW_CONSOLE

See Also:

• Constant Field Values

DISALLOW_CONSOLE_USE_DEFAULT

static final String DISALLOW_CONSOLE_USE_DEFAULT

See Also:

• Constant Field Values

LOAD_IMAGE_RESOURCE_ID

static final String LOAD_IMAGE_RESOURCE_ID

See Also:

• Constant Field Values

MANAGE_BROWSER_HISTORY

static final String MANAGE_BROWSER_HISTORY

See Also:

• Constant Field Values

MANAGE_BROWSER_HISTORY_USE_DEFAULT

static final String MANAGE_BROWSER_HISTORY_USE_DEFAULT

See Also:

• Constant Field Values

NAME

static final String NAME

See Also:

• Constant Field Values

OMIT_BASIS_CSS

static final String OMIT_BASIS_CSS

See Also:

• Constant Field Values

OMIT_BASIS_CSS_USE_DEFAULT

static final String OMIT_BASIS_CSS_USE_DEFAULT

See Also:

• Constant Field Values

PROGRAM

static final String PROGRAM

See Also:

• Constant Field Values

QUIET

static final String QUIET

See Also:

• Constant Field Values

SECURE

static final String SECURE

See Also:

• Constant Field Values

SECURE_USE_DEFAULT

static final String SECURE_USE_DEFAULT

See Also:

• Constant Field Values

SHORTCUT_ICON_RESOURCE_ID

static final String SHORTCUT_ICON_RESOURCE_ID

See Also:

• Constant Field Values

SHOW_BROWSER_WARNING

static final String SHOW_BROWSER_WARNING

See Also:

• Constant Field Values

SHOW_BROWSER_WARNING_USE_DEFAULT

static final String SHOW_BROWSER_WARNING_USE_DEFAULT

See Also:

• Constant Field Values

SHOW_CONFIRM_CLOSE_DIALOG

static final String SHOW_CONFIRM_CLOSE_DIALOG

See Also:

• Constant Field Values

SHOW_CONFIRM_CLOSE_DIALOG_USE_DEFAULT

static final String SHOW_CONFIRM_CLOSE_DIALOG_USE_DEFAULT

See Also:

• Constant Field Values

TERMINAL

static final String TERMINAL

See Also:

• Constant Field Values

WORKING_DIRECTORY

static final String WORKING_DIRECTORY

See Also:

• Constant Field Values

Method Details

getArguments

BBjAdminList<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

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