sapphire.action

Class BaseAction

java.lang.Object

com.labvantage.sapphire.BaseCustom

sapphire.action.BaseAction

Direct Known Subclasses:

com.labvantage.sapphire.scheduler.BaseScheduleTask

public abstract class BaseAction
extends com.labvantage.sapphire.BaseCustom

Field Summary

Fields

Modifier and Type	Field and Description
protected com.labvantage.sapphire.services.ConnectionInfo	connectionInfo
protected DBAccess	database
static java.lang.String	DEFAULT_SEPARATOR
static java.lang.String	ESC_SEMICOLON
static java.lang.String	NO
static java.lang.String	NULL
static java.lang.String	POLL
static java.lang.String	RETURN
static java.lang.String	RETURN_FAILURE
static java.lang.String	RETURN_SUCCESS
static java.lang.String	TYPE_CONFIRM
static java.lang.String	TYPE_FAILURE
static java.lang.String	TYPE_INFORMATION
static java.lang.String	TYPE_VALIDATION
static java.lang.String	VERSION
static java.lang.String	YES

Fields inherited from class com.labvantage.sapphire.BaseCustom

FAILURE, logger, logName, SUCCESS

Constructor Summary

Constructors

Constructor and Description
BaseAction()

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	createDatabaseTransactionLogId(PropertyList properties)
protected java.lang.String	createDatabaseTransactionLogId(java.lang.String sdcid, java.lang.String keyid1, java.lang.String keyid2, java.lang.String keyid3, PropertyList properties)
void	endAction()
ErrorHandler	getErrorHandler()
boolean	isDatabaseRequired()
protected void	logError(java.lang.String message) Deprecated. As of version 5.0 replaced by Logger API
protected void	logTrace(java.lang.String message) Deprecated. As of version 5.0 replaced by Logger API
void	processAction(PropertyList properties)
int	processAction(java.lang.String actionid, java.lang.String actionversionid, java.util.HashMap properties)
protected int	setError(java.lang.String message)
protected int	setError(java.lang.String message, java.lang.Exception e)
protected int	setError(java.lang.String errorid, java.lang.String message)
protected int	setError(java.lang.String errorid, java.lang.String message, java.lang.Exception e)
int	setError(java.lang.String errorid, java.lang.String errorType, java.lang.String message)
int	setError(java.lang.String errorid, java.lang.String errorType, java.lang.String message, java.lang.Throwable e)
void	setErrors(ErrorHandler errorHandler)
void	setInfoError(java.lang.String message)
void	setInfoError(java.lang.String errorid, java.lang.String message)
void	startAction(java.lang.String actionid, com.labvantage.sapphire.services.SapphireConnection sapphireConnection, ErrorHandler errorHandler)

Methods inherited from class com.labvantage.sapphire.BaseCustom

getAccessorErrorIds, getAccessorErrorMsgs, getActionProcessor, getConfigurationProcessor, getConnectionid, getConnectionId, getConnectionProcessor, getDAMProcessor, getDepartmentList, getHttpProcessor, getQueryProcessor, getRakFile, getSDCProcessor, getSDIProcessor, getSequenceProcessor, getTranslationProcessor, setConnectionId, setLanguage, setRakFile

Methods inherited from class java.lang.Object

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

Field Detail

YES

public static final java.lang.String YES

See Also:

Constant Field Values

NO

public static final java.lang.String NO

See Also:

Constant Field Values

NULL

public static final java.lang.String NULL

See Also:

Constant Field Values

POLL

public static final java.lang.String POLL

See Also:

Constant Field Values

DEFAULT_SEPARATOR

public static final java.lang.String DEFAULT_SEPARATOR

See Also:

Constant Field Values

RETURN

public static final java.lang.String RETURN

See Also:

Constant Field Values

RETURN_SUCCESS

public static final java.lang.String RETURN_SUCCESS

See Also:

Constant Field Values

RETURN_FAILURE

public static final java.lang.String RETURN_FAILURE

See Also:

Constant Field Values

VERSION

public static final java.lang.String VERSION

See Also:

Constant Field Values

ESC_SEMICOLON

public static final java.lang.String ESC_SEMICOLON

See Also:

Constant Field Values

TYPE_FAILURE

public static final java.lang.String TYPE_FAILURE

See Also:

Constant Field Values

TYPE_CONFIRM

public static final java.lang.String TYPE_CONFIRM

See Also:

Constant Field Values

TYPE_VALIDATION

public static final java.lang.String TYPE_VALIDATION

See Also:

Constant Field Values

TYPE_INFORMATION

public static final java.lang.String TYPE_INFORMATION

See Also:

Constant Field Values

database

protected DBAccess database

connectionInfo

protected com.labvantage.sapphire.services.ConnectionInfo connectionInfo

Constructor Detail

BaseAction

public BaseAction()

Method Detail

startAction

public void startAction(java.lang.String actionid,
                        com.labvantage.sapphire.services.SapphireConnection sapphireConnection,
                        ErrorHandler errorHandler)
                 throws SapphireException

Throws:

SapphireException

isDatabaseRequired

public boolean isDatabaseRequired()

processAction

public void processAction(PropertyList properties)
                   throws SapphireException

Throws:

SapphireException

processAction

public int processAction(java.lang.String actionid,
                         java.lang.String actionversionid,
                         java.util.HashMap properties)

endAction

public void endAction()

logTrace

protected void logTrace(java.lang.String message)

Deprecated. As of version 5.0 replaced by Logger API

Put an information message in the log file

Parameters:

message - the message to put into the file

logError

protected void logError(java.lang.String message)

Deprecated. As of version 5.0 replaced by Logger API

Put an error message in the log file

Parameters:

message - the message to put into the file

setError

protected int setError(java.lang.String message)

setError

protected int setError(java.lang.String errorid,
                       java.lang.String message)

setError

protected int setError(java.lang.String message,
                       java.lang.Exception e)

setError

protected int setError(java.lang.String errorid,
                       java.lang.String message,
                       java.lang.Exception e)

setError

public int setError(java.lang.String errorid,
                    java.lang.String errorType,
                    java.lang.String message,
                    java.lang.Throwable e)

setError

public int setError(java.lang.String errorid,
                    java.lang.String errorType,
                    java.lang.String message)

setErrors

public void setErrors(ErrorHandler errorHandler)

setInfoError

public void setInfoError(java.lang.String message)

setInfoError

public void setInfoError(java.lang.String errorid,
                         java.lang.String message)

getErrorHandler

public ErrorHandler getErrorHandler()

createDatabaseTransactionLogId

protected java.lang.String createDatabaseTransactionLogId(PropertyList properties)
                                                   throws SapphireException

Throws:

SapphireException

createDatabaseTransactionLogId

protected java.lang.String createDatabaseTransactionLogId(java.lang.String sdcid,
                                                          java.lang.String keyid1,
                                                          java.lang.String keyid2,
                                                          java.lang.String keyid3,
                                                          PropertyList properties)
                                                   throws SapphireException

Throws:

SapphireException