com.cs.software.engine

Class ServiceBase

java.lang.Object

com.cs.software.engine.ServiceBase

All Implemented Interfaces:

ServicesIntf, Serializable

public abstract class ServiceBase
extends Object
implements ServicesIntf

Author:

Steve Crombie

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static Boolean	BOOLEAN_FALSE
protected String	databasePoolName
protected List<Map<String,Object>>	paramList
protected static String	sepChar

Fields inherited from interface com.cs.software.api.ServicesIntf

LOG_PARAM_LOGFIELDS, LOG_PARAM_LOGMESSAGE, LOG_PARAM_LOGTYPE, LOG_TYPE_DEBUG, LOG_TYPE_ERROR, LOG_TYPE_INFO, LOG_TYPE_SYSTEM_OUT, LOG_TYPE_WARN

Constructor Summary

Constructors

Constructor and Description
ServiceBase()

Method Summary

Modifier and Type	Method and Description
abstract ServicesIntf	cloneService()
int	getDefError()
MessageIntf	getMessage()
String	getServiceDisplayName()
String	getServiceName()
void	init(EngineIntf anEngine, MessageIntf aMessage) Used to initialize the object and to pass in all parameters need to run function.
void	resetService()
abstract MessageIntf	runService()
void	runServicePost()
void	runServicePre()
void	setFunctionParams(List<Map<String,Object>> aParamList, String aDatabasePoolName) Used to set the current parameters associated with this function.
void	setServiceDisplayName(String aName)
void	setServiceName(String aName)
void	shutdown()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.cs.software.api.ServicesIntf

convertTemplateMessage, getFieldDataFromMsg, init

Field Detail

BOOLEAN_FALSE

protected static final Boolean BOOLEAN_FALSE

sepChar

protected static final String sepChar

paramList

protected List<Map<String,Object>> paramList

databasePoolName

protected String databasePoolName

Constructor Detail

ServiceBase

public ServiceBase()

Method Detail

getServiceName

public String getServiceName()

Specified by:

getServiceName in interface ServicesIntf

setServiceName

public void setServiceName(String aName)

Specified by:

setServiceName in interface ServicesIntf

getServiceDisplayName

public String getServiceDisplayName()

Specified by:

getServiceDisplayName in interface ServicesIntf

setServiceDisplayName

public void setServiceDisplayName(String aName)

Specified by:

setServiceDisplayName in interface ServicesIntf

setFunctionParams

public void setFunctionParams(List<Map<String,Object>> aParamList,
                              String aDatabasePoolName)
                       throws Exception

Used to set the current parameters associated with this function.

Specified by:

setFunctionParams in interface ServicesIntf

Throws:

Exception

init

public void init(EngineIntf anEngine,
                 MessageIntf aMessage)
          throws Exception

Used to initialize the object and to pass in all parameters need to run function.

Parameters:

anEngine - engine

aMessage - msg

Throws:

Exception - ex

getMessage

public MessageIntf getMessage()

Specified by:

getMessage in interface ServicesIntf

runServicePre

public void runServicePre()
                   throws Exception

Specified by:

runServicePre in interface ServicesIntf

Throws:

Exception

runService

public abstract MessageIntf runService()

Specified by:

runService in interface ServicesIntf

runServicePost

public void runServicePost()
                    throws Exception

Specified by:

runServicePost in interface ServicesIntf

Throws:

Exception

cloneService

public abstract ServicesIntf cloneService()
                                   throws Exception

Specified by:

cloneService in interface ServicesIntf

Throws:

Exception

resetService

public void resetService()
                  throws Exception

Specified by:

resetService in interface ServicesIntf

Throws:

Exception

shutdown

public void shutdown()

Specified by:

shutdown in interface ServicesIntf

getDefError

public int getDefError()