psdi.app.recontask.engine

Class ReconContext

java.lang.Object

psdi.app.recontask.engine.ReconContext

Direct Known Subclasses:

ComparatorContext, DataSetContext

public class ReconContext
extends java.lang.Object

This class provides an interface through which the data set provider classes can use the services and information provided by the recon engine.

Author:

Qiang(John) Wen

Constructor Summary

Constructors

Constructor and Description
ReconContext(ReconInfo reconInfo) Constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCronName() Expose the current cron task name to data set providers.
DataSet	getDataSet1()
DataSet	getDataSet2()
DBShortcut	getDBShortcut() Convenience method to provide data set providers a valid DBShortcut object.
java.lang.String	getInstanceName() Expose the current cron task instance name to data set providers.
MXLogger	getLogger() Expose the maximo logger to data set providers to adding logging data.
ReconInfo	getReconInfo() Expose the ReconInfo.
MXLogger	getSqlLogger() Expose the maximo SQL logger to data set providers to adding SQL logging data.
MboRemote	getTask() Expose the current recon task MBO to data set providers.
java.lang.String	getTaskName() Expose the current recon task name to data set providers.
UserInfo	getUserInfo() Expose the UserInfo object.
void	releaseDBShortcut(DBShortcut dbShortcut) Release a previously obtained DBShortcut

Methods inherited from class java.lang.Object

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

Constructor Detail

ReconContext

public ReconContext(ReconInfo reconInfo)

Constructor. It takes a valid ReconInfo object so that the service can be delegated to it.

Parameters:

reconInfo -

Method Detail

getReconInfo

public ReconInfo getReconInfo()

Expose the ReconInfo.

Returns:

the ReconInfo object.

getUserInfo

public UserInfo getUserInfo()

Expose the UserInfo object. It may be needed for using in constructing SQLFormat or running SQL statements.

Returns:

The Maximo UserInfo object

getLogger

public MXLogger getLogger()

Expose the maximo logger to data set providers to adding logging data.

Returns:

The Maximo logger

getSqlLogger

public MXLogger getSqlLogger()

Expose the maximo SQL logger to data set providers to adding SQL logging data.

Returns:

The Maximo SQL ogger

getCronName

public java.lang.String getCronName()

Expose the current cron task name to data set providers.

Returns:

The current cron task name

getInstanceName

public java.lang.String getInstanceName()

Expose the current cron task instance name to data set providers.

Returns:

The current cron task instance name

getTaskName

public java.lang.String getTaskName()

Expose the current recon task name to data set providers.

Returns:

The current recon task name

getTask

public MboRemote getTask()

Expose the current recon task MBO to data set providers.

Returns:

The current recon task MBO

getDBShortcut

public DBShortcut getDBShortcut()
                         throws MXException,
                                java.rmi.RemoteException

Convenience method to provide data set providers a valid DBShortcut object. The data set providers can use it to run SQL statements. And they need to release it after they are done with it.

Returns:

A valid DBShortcut

Throws:

MXException

java.rmi.RemoteException

releaseDBShortcut

public void releaseDBShortcut(DBShortcut dbShortcut)

Release a previously obtained DBShortcut

Parameters:

dbShortcut - to be released.

getDataSet1

public DataSet getDataSet1()

getDataSet2

public DataSet getDataSet2()