Package com.basis.api.admin

Interface BBjAdminTriggers

All Superinterfaces:

BBjAdminCommitPropertyWriter, BBjAdminCommitWriter, BBjAdminPropertyReader, BBjAdminPropertyWriter, Remote

public interface BBjAdminTriggers
extends BBjAdminCommitPropertyWriter

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AFTER_CLOSE_ENABLED
static final String	AFTER_CLOSE_PROGRAM
static final String	AFTER_CLOSE_SOURCE
static final String	AFTER_ERASE_ENABLED
static final String	AFTER_ERASE_PROGRAM
static final String	AFTER_ERASE_SOURCE
static final String	AFTER_KEY_ENABLED
static final String	AFTER_KEY_PROGRAM
static final String	AFTER_KEY_SOURCE
static final String	AFTER_OPEN_ENABLED
static final String	AFTER_OPEN_PROGRAM
static final String	AFTER_OPEN_SOURCE
static final String	AFTER_READ_ENABLED
static final String	AFTER_READ_PROGRAM
static final String	AFTER_READ_SOURCE
static final String	AFTER_REMOVE_ENABLED
static final String	AFTER_REMOVE_PROGRAM
static final String	AFTER_REMOVE_SOURCE
static final String	AFTER_WRITE_ENABLED
static final String	AFTER_WRITE_PROGRAM
static final String	AFTER_WRITE_SOURCE
static final String	BEFORE_CLOSE_ENABLED
static final String	BEFORE_CLOSE_PROGRAM
static final String	BEFORE_CLOSE_SOURCE
static final String	BEFORE_ERASE_ENABLED
static final String	BEFORE_ERASE_PROGRAM
static final String	BEFORE_ERASE_SOURCE
static final String	BEFORE_KEY_ENABLED
static final String	BEFORE_KEY_PROGRAM
static final String	BEFORE_KEY_SOURCE
static final String	BEFORE_OPEN_ENABLED
static final String	BEFORE_OPEN_PROGRAM
static final String	BEFORE_OPEN_SOURCE
static final String	BEFORE_READ_ENABLED
static final String	BEFORE_READ_PROGRAM
static final String	BEFORE_READ_SOURCE
static final String	BEFORE_REMOVE_ENABLED
static final String	BEFORE_REMOVE_PROGRAM
static final String	BEFORE_REMOVE_SOURCE
static final String	BEFORE_WRITE_ENABLED
static final String	BEFORE_WRITE_PROGRAM
static final String	BEFORE_WRITE_SOURCE
static final String	CLASSPATH
static final String	CONFIG
static final String	ENABLED
static final int	FILE_FORMAT_ASCII
static final int	FILE_FORMAT_BBJ
static final String	FILE_NAME
static final String	INSTEAD_OF_CLOSE_ENABLED
static final String	INSTEAD_OF_CLOSE_PROGRAM
static final String	INSTEAD_OF_CLOSE_SOURCE
static final String	INSTEAD_OF_ERASE_ENABLED
static final String	INSTEAD_OF_ERASE_PROGRAM
static final String	INSTEAD_OF_ERASE_SOURCE
static final String	INSTEAD_OF_KEY_ENABLED
static final String	INSTEAD_OF_KEY_PROGRAM
static final String	INSTEAD_OF_KEY_SOURCE
static final String	INSTEAD_OF_OPEN_ENABLED
static final String	INSTEAD_OF_OPEN_PROGRAM
static final String	INSTEAD_OF_OPEN_SOURCE
static final String	INSTEAD_OF_READ_ENABLED
static final String	INSTEAD_OF_READ_PROGRAM
static final String	INSTEAD_OF_READ_SOURCE
static final String	INSTEAD_OF_REMOVE_ENABLED
static final String	INSTEAD_OF_REMOVE_PROGRAM
static final String	INSTEAD_OF_REMOVE_SOURCE
static final String	INSTEAD_OF_WRITE_ENABLED
static final String	INSTEAD_OF_WRITE_PROGRAM
static final String	INSTEAD_OF_WRITE_SOURCE
static final String	RUN_AS_PASSWORD
static final String	RUN_AS_USER
static final String	WORKING_DIR
static final String	WORKING_DIR_IS_DEFAULT

Method Summary

Modifier and Type	Method	Description
BBjAdminList<BBjAdminProperty>	getDescriptiveProperties()	Used primarily by GUI applications like the Enterprise Manager to dynamically generate an admin UI.
int	getFileFormat(String p_programProperty)	Returns the current file format for the file for the specified program if the file already exists.
void	setDescriptiveProperties(BBjAdminList<BBjAdminProperty> p_descriptiveProps)	Used primarily by GUI applications like the Enterprise Manager to dynamically generate an admin UI.
void	writeSourceFile(String p_programProperty, String p_code, int p_fileFormat)	Call this method to actually write the source code to its appropriate file.

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

Field Details

FILE_NAME

static final String FILE_NAME

See Also:

• Constant Field Values

ENABLED

static final String ENABLED

See Also:

• Constant Field Values

WORKING_DIR

static final String WORKING_DIR

See Also:

• Constant Field Values

WORKING_DIR_IS_DEFAULT

static final String WORKING_DIR_IS_DEFAULT

See Also:

• Constant Field Values

CONFIG

static final String CONFIG

See Also:

• Constant Field Values

RUN_AS_USER

static final String RUN_AS_USER

See Also:

• Constant Field Values

RUN_AS_PASSWORD

static final String RUN_AS_PASSWORD

See Also:

• Constant Field Values

CLASSPATH

static final String CLASSPATH

See Also:

• Constant Field Values

AFTER_READ_ENABLED

static final String AFTER_READ_ENABLED

See Also:

• Constant Field Values

AFTER_READ_PROGRAM

static final String AFTER_READ_PROGRAM

See Also:

• Constant Field Values

AFTER_READ_SOURCE

static final String AFTER_READ_SOURCE

See Also:

• Constant Field Values

BEFORE_READ_ENABLED

static final String BEFORE_READ_ENABLED

See Also:

• Constant Field Values

BEFORE_READ_PROGRAM

static final String BEFORE_READ_PROGRAM

See Also:

• Constant Field Values

BEFORE_READ_SOURCE

static final String BEFORE_READ_SOURCE

See Also:

• Constant Field Values

INSTEAD_OF_READ_ENABLED

static final String INSTEAD_OF_READ_ENABLED

See Also:

• Constant Field Values

INSTEAD_OF_READ_PROGRAM

static final String INSTEAD_OF_READ_PROGRAM

See Also:

• Constant Field Values

INSTEAD_OF_READ_SOURCE

static final String INSTEAD_OF_READ_SOURCE

See Also:

• Constant Field Values

AFTER_KEY_ENABLED

static final String AFTER_KEY_ENABLED

See Also:

• Constant Field Values

AFTER_KEY_PROGRAM

static final String AFTER_KEY_PROGRAM

See Also:

• Constant Field Values

AFTER_KEY_SOURCE

static final String AFTER_KEY_SOURCE

See Also:

• Constant Field Values

BEFORE_KEY_ENABLED

static final String BEFORE_KEY_ENABLED

See Also:

• Constant Field Values

BEFORE_KEY_PROGRAM

static final String BEFORE_KEY_PROGRAM

See Also:

• Constant Field Values

BEFORE_KEY_SOURCE

static final String BEFORE_KEY_SOURCE

See Also:

• Constant Field Values

INSTEAD_OF_KEY_ENABLED

static final String INSTEAD_OF_KEY_ENABLED

See Also:

• Constant Field Values

INSTEAD_OF_KEY_PROGRAM

static final String INSTEAD_OF_KEY_PROGRAM

See Also:

• Constant Field Values

INSTEAD_OF_KEY_SOURCE

static final String INSTEAD_OF_KEY_SOURCE

See Also:

• Constant Field Values

AFTER_WRITE_ENABLED

static final String AFTER_WRITE_ENABLED

See Also:

• Constant Field Values

AFTER_WRITE_PROGRAM

static final String AFTER_WRITE_PROGRAM

See Also:

• Constant Field Values

AFTER_WRITE_SOURCE

static final String AFTER_WRITE_SOURCE

See Also:

• Constant Field Values

BEFORE_WRITE_ENABLED

static final String BEFORE_WRITE_ENABLED

See Also:

• Constant Field Values

BEFORE_WRITE_PROGRAM

static final String BEFORE_WRITE_PROGRAM

See Also:

• Constant Field Values

BEFORE_WRITE_SOURCE

static final String BEFORE_WRITE_SOURCE

See Also:

• Constant Field Values

INSTEAD_OF_WRITE_ENABLED

static final String INSTEAD_OF_WRITE_ENABLED

See Also:

• Constant Field Values

INSTEAD_OF_WRITE_PROGRAM

static final String INSTEAD_OF_WRITE_PROGRAM

See Also:

• Constant Field Values

INSTEAD_OF_WRITE_SOURCE

static final String INSTEAD_OF_WRITE_SOURCE

See Also:

• Constant Field Values

AFTER_REMOVE_ENABLED

static final String AFTER_REMOVE_ENABLED

See Also:

• Constant Field Values

AFTER_REMOVE_PROGRAM

static final String AFTER_REMOVE_PROGRAM

See Also:

• Constant Field Values

AFTER_REMOVE_SOURCE

static final String AFTER_REMOVE_SOURCE

See Also:

• Constant Field Values

BEFORE_REMOVE_ENABLED

static final String BEFORE_REMOVE_ENABLED

See Also:

• Constant Field Values

BEFORE_REMOVE_PROGRAM

static final String BEFORE_REMOVE_PROGRAM

See Also:

• Constant Field Values

BEFORE_REMOVE_SOURCE

static final String BEFORE_REMOVE_SOURCE

See Also:

• Constant Field Values

INSTEAD_OF_REMOVE_ENABLED

static final String INSTEAD_OF_REMOVE_ENABLED

See Also:

• Constant Field Values

INSTEAD_OF_REMOVE_PROGRAM

static final String INSTEAD_OF_REMOVE_PROGRAM

See Also:

• Constant Field Values

INSTEAD_OF_REMOVE_SOURCE

static final String INSTEAD_OF_REMOVE_SOURCE

See Also:

• Constant Field Values

AFTER_OPEN_ENABLED

static final String AFTER_OPEN_ENABLED

See Also:

• Constant Field Values

AFTER_OPEN_PROGRAM

static final String AFTER_OPEN_PROGRAM

See Also:

• Constant Field Values

AFTER_OPEN_SOURCE

static final String AFTER_OPEN_SOURCE

See Also:

• Constant Field Values

BEFORE_OPEN_ENABLED

static final String BEFORE_OPEN_ENABLED

See Also:

• Constant Field Values

BEFORE_OPEN_PROGRAM

static final String BEFORE_OPEN_PROGRAM

See Also:

• Constant Field Values

BEFORE_OPEN_SOURCE

static final String BEFORE_OPEN_SOURCE

See Also:

• Constant Field Values

INSTEAD_OF_OPEN_ENABLED

static final String INSTEAD_OF_OPEN_ENABLED

See Also:

• Constant Field Values

INSTEAD_OF_OPEN_PROGRAM

static final String INSTEAD_OF_OPEN_PROGRAM

See Also:

• Constant Field Values

INSTEAD_OF_OPEN_SOURCE

static final String INSTEAD_OF_OPEN_SOURCE

See Also:

• Constant Field Values

AFTER_CLOSE_ENABLED

static final String AFTER_CLOSE_ENABLED

See Also:

• Constant Field Values

AFTER_CLOSE_PROGRAM

static final String AFTER_CLOSE_PROGRAM

See Also:

• Constant Field Values

AFTER_CLOSE_SOURCE

static final String AFTER_CLOSE_SOURCE

See Also:

• Constant Field Values

BEFORE_CLOSE_ENABLED

static final String BEFORE_CLOSE_ENABLED

See Also:

• Constant Field Values

BEFORE_CLOSE_PROGRAM

static final String BEFORE_CLOSE_PROGRAM

See Also:

• Constant Field Values

BEFORE_CLOSE_SOURCE

static final String BEFORE_CLOSE_SOURCE

See Also:

• Constant Field Values

INSTEAD_OF_CLOSE_ENABLED

static final String INSTEAD_OF_CLOSE_ENABLED

See Also:

• Constant Field Values

INSTEAD_OF_CLOSE_PROGRAM

static final String INSTEAD_OF_CLOSE_PROGRAM

See Also:

• Constant Field Values

INSTEAD_OF_CLOSE_SOURCE

static final String INSTEAD_OF_CLOSE_SOURCE

See Also:

• Constant Field Values

AFTER_ERASE_ENABLED

static final String AFTER_ERASE_ENABLED

See Also:

• Constant Field Values

AFTER_ERASE_PROGRAM

static final String AFTER_ERASE_PROGRAM

See Also:

• Constant Field Values

AFTER_ERASE_SOURCE

static final String AFTER_ERASE_SOURCE

See Also:

• Constant Field Values

BEFORE_ERASE_ENABLED

static final String BEFORE_ERASE_ENABLED

See Also:

• Constant Field Values

BEFORE_ERASE_PROGRAM

static final String BEFORE_ERASE_PROGRAM

See Also:

• Constant Field Values

BEFORE_ERASE_SOURCE

static final String BEFORE_ERASE_SOURCE

See Also:

• Constant Field Values

INSTEAD_OF_ERASE_ENABLED

static final String INSTEAD_OF_ERASE_ENABLED

See Also:

• Constant Field Values

INSTEAD_OF_ERASE_PROGRAM

static final String INSTEAD_OF_ERASE_PROGRAM

See Also:

• Constant Field Values

INSTEAD_OF_ERASE_SOURCE

static final String INSTEAD_OF_ERASE_SOURCE

See Also:

• Constant Field Values

FILE_FORMAT_ASCII

static final int FILE_FORMAT_ASCII

See Also:

• Constant Field Values

FILE_FORMAT_BBJ

static final int FILE_FORMAT_BBJ

See Also:

• Constant Field Values

Method Details

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

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

writeSourceFile

void writeSourceFile(String p_programProperty,
 String p_code,
 int p_fileFormat)
              throws BBjAdminException

Call this method to actually write the source code to its appropriate file. Since the object contains all of the trigger configuration as well as all the source code from all the types of triggers, this is a safer way to allow them to update code for one piece without risking affecting any other aspect of the trigger. It is not necessary to call commit() after making this call as this call will immediately safe the changes to the source code file.

Parameters:

p_programProperty - Property the code should be set for: AFTER_READ_PROGRAM, BEFORE_WRITE_PROGRAM, etc.

p_code - The complete source code for the program file. Contents will be overwritten with the value in this parameter.

Throws:

BBjAdminException

getFileFormat

int getFileFormat(String p_programProperty)
           throws BBjAdminException

Returns the current file format for the file for the specified program if the file already exists.

Parameters:

p_programProperty - Property the code should be set for: AFTER_READ_PROGRAM, BEFORE_WRITE_PROGRAM, etc.

Returns:

Value corresponding to the available format types FILE_FORMAT_ASCII or FILE_FORMAT_BBJ

Throws:

BBjAdminException