oracle.ifs.utils.action

Class AbstractAction

java.lang.Object

oracle.ifs.utils.action.AbstractAction

All Implemented Interfaces:

Action

Direct Known Subclasses:

BaseAppAction, DisposeServiceAction, FileHandlingAction, ForkProcessAction, JDBCAction, LibrarySessionAction, ListAction, SchemaCreator, SQLScriptAction

public abstract class AbstractAction
extends Object
implements Action

AbstractAction provides a default implementation for the Action interface.

Version:

1.0.6

Author:

Luis Saenz

Modified:

dlong 07/18/2018 ECMSDK-429: Added isPostgres()., sgarg 02/24/2002 Added "continue.on.error" property., lsaenz 12/12/2000 Added setOptions method again., lsaenz 08/20/2000 Changed setOptions to setDefaultOptions., lsaenz 08/19/2000 Added setOptions method; name, description., lsaenz 08/02/2000 Cleaned up; updated comments., lsaenz 07/10/2000 Changed putValue to remove key if value == null, return the old value., lsaenz 07/06/2000 Created.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTINUE_ON_ERROR Option key specifying if the action should continue on an error or not.
protected Hashtable	m_defaultOptions A Hashtable containing the default options for this AbstractAction.
protected Hashtable	m_options A Hashtable containing the options for this AbstractAction.

Constructor Summary

Constructors

Constructor and Description
AbstractAction() Creates a new AbstractAction.

Method Summary

Modifier and Type	Method and Description
String	getDescription() Returns this Action's description.
String	getName() Returns this Action's name.
Object	getValue(String key) Searches for the option with the specified key.
protected boolean	isContinueOnError()
boolean	isPostgres() Returns true if the target database is of type PostreSQL.
Object	putValue(String key, Object value) Calls the Hashtable method put, or the Hashtable method remove if the given value is null.
void	setDefaultOptions(Hashtable options) Sets the default options for this AbstractAction.
void	setDescription(String description) Sets this Action's description.
void	setName(String name) Sets this Action's name.
void	setOptions(Hashtable options) Replaces this AbstractAction's options table.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface oracle.ifs.utils.action.Action

failed, perform, stop

Field Detail

CONTINUE_ON_ERROR

public static final String CONTINUE_ON_ERROR

Option key specifying if the action should continue on an error or not. If "true" then the action does not throw an exception even if there was an error. Defined as "continue.on.error".

See Also:

Constant Field Values

m_options

protected Hashtable m_options

A Hashtable containing the options for this AbstractAction.

m_defaultOptions

protected Hashtable m_defaultOptions

A Hashtable containing the default options for this AbstractAction.

Constructor Detail

AbstractAction

public AbstractAction()

Creates a new AbstractAction.

Method Detail

setOptions

public void setOptions(Hashtable options)

Replaces this AbstractAction's options table.

Parameters:

options - the Hashtable that should be used as the options table.

setDefaultOptions

public void setDefaultOptions(Hashtable options)

Sets the default options for this AbstractAction. The default options is searched if the option key is not found in the primary options.

Parameters:

options - the Hashtable that should be used as the default options.

setName

public void setName(String name)

Sets this Action's name.

Specified by:

setName in interface Action

Parameters:

name - the name to set for this Action.

setDescription

public void setDescription(String description)

Sets this Action's description.

Specified by:

setDescription in interface Action

Parameters:

description - the description to set for this Action.

getValue

public Object getValue(String key)

Searches for the option with the specified key. If the key is not found, the default options are then checked. The method returns null if the option is not found.

Specified by:

getValue in interface Action

Parameters:

key - the option key.

Returns:

the value in the option list with the specified key value.

putValue

public Object putValue(String key,
                       Object value)

Calls the Hashtable method put, or the Hashtable method remove if the given value is null.

Specified by:

putValue in interface Action

Parameters:

key - the option key.

value - the option value.

Returns:

the old value of the option with the specified key value.

getName

public String getName()

Description copied from interface: Action

Returns this Action's name.

Specified by:

getName in interface Action

Returns:

this Action's name, or null if this Action has no name.

getDescription

public String getDescription()

Description copied from interface: Action

Returns this Action's description.

Specified by:

getDescription in interface Action

Returns:

This Action's description, or null if this Action has no description.

isContinueOnError

protected boolean isContinueOnError()

isPostgres

public boolean isPostgres()

Returns true if the target database is of type PostreSQL.

Returns:

true if setting indicates the target database is of type PostgreSQL; false otherwise