com.ibm.tivoli.maximo.optimization.service

Interface OptimizationServiceRemote

All Superinterfaces:

AppServiceRemote, java.rmi.Remote, ServiceRemote

All Known Implementing Classes:

OptimizationService

public interface OptimizationServiceRemote
extends AppServiceRemote

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ABORTED
static java.lang.String	ABORTING
static java.lang.String	FAILED
static java.lang.String	PROCESSED
static java.lang.String	PROCESSING

Method Summary

Modifier and Type	Method and Description
void	deployOptimizationApp(java.lang.String odmApplicationName, ODMAppDeployInfo appDeployInfo, UserInfo userInfo) Takes the application package from the Java EE EAR (i.e from build) and then applies the deployment configuration to it and then deploys the application.
void	finishSKDODMERUN(long skdProjectId, java.lang.String status) Delete "optimization running" for the passed in scenario
void	finishSKDODMERUN(long skdProjectId, java.lang.String status, long skdOdmeRunId) Delete "optimization running" for the passed in scenario
java.lang.String	getOptimizationMosAPIBaseURL(UserInfo userInfo)
java.lang.String	getOptimizationMosAPIKey(UserInfo userInfo)
boolean	getUseCPS(UserInfo userInfo) Returns true if the CPS system property is set to true
void	listenToODMERun(MboRemote listenerMbo, boolean listen, long skdProjectId) Register another listener for ODME scenario run
void	ODMEaddRunMsg(long skdProjectId, UserInfo userInfo, java.lang.String message, boolean key) Allow sender to add a message to our map.
void	ODMEclearCompleted() Allow sender to clear completed tasks of our map.
void	ODMEclearRunMsg(long skdProjectId) Allow sender to clear messages of our map.
boolean	ODMEIsRunning(long skdProjectId) Return true if ODME is in progress for the scenario
boolean	runOptimization(UserInfo userInfo, java.lang.String odmApplicationName, OptimizationInputProcessParameters inputProcessParameters, OptimizationOutputProcessParameters outputProcessParameters)
void	setJobIDSKDODMERUN(long skdOdmeRunId, java.lang.String mosJobId) Updates the SKDODMERUN.MOSJOBID for the passed in parameters.
long	startSKDODMERUN(long skdProjectId, java.lang.String user, java.lang.String status) Add "optimization running" for the passed in scenario

Methods inherited from interface psdi.server.AppServiceRemote

checkSecurity, getCriteria, getCurrentState, getLiveObjCount, getMboSet, getName, getSchemaOwner, getSetForRelationship, getSetFromKeys, getStateCmdList, getStateList, getURL, verifyUser, verifyUser

Methods inherited from interface psdi.server.ServiceRemote

isAppService, isSingletonService, restart

Field Detail

PROCESSING

static final java.lang.String PROCESSING

See Also:

Constant Field Values

PROCESSED

static final java.lang.String PROCESSED

See Also:

Constant Field Values

FAILED

static final java.lang.String FAILED

See Also:

Constant Field Values

ABORTING

static final java.lang.String ABORTING

See Also:

Constant Field Values

ABORTED

static final java.lang.String ABORTED

See Also:

Constant Field Values

Method Detail

deployOptimizationApp

void deployOptimizationApp(java.lang.String odmApplicationName,
                           ODMAppDeployInfo appDeployInfo,
                           UserInfo userInfo)
                    throws java.rmi.RemoteException,
                           MXException

Takes the application package from the Java EE EAR (i.e from build) and then applies the deployment configuration to it and then deploys the application. After deployment, updates the database with the deployed application package.

Parameters:

odmApplicationName -

appDeployInfo -

userInfo -

Throws:

java.rmi.RemoteException

MXException

runOptimization

boolean runOptimization(UserInfo userInfo,
                        java.lang.String odmApplicationName,
                        OptimizationInputProcessParameters inputProcessParameters,
                        OptimizationOutputProcessParameters outputProcessParameters)
                 throws java.rmi.RemoteException,
                        MXException

Throws:

java.rmi.RemoteException

MXException

listenToODMERun

void listenToODMERun(MboRemote listenerMbo,
                     boolean listen,
                     long skdProjectId)
              throws MXException,
                     java.rmi.RemoteException

Register another listener for ODME scenario run

Parameters:

listenerMbo - ProcessMonitor mbo.

listen - True to start listening, False to stop listening

skdProjectId - skdproject unique id

Throws:

MXException

java.rmi.RemoteException

ODMEIsRunning

boolean ODMEIsRunning(long skdProjectId)
               throws MXException,
                      java.rmi.RemoteException

Return true if ODME is in progress for the scenario

Parameters:

skdProjectId - skdproject unique id

Throws:

MXException

java.rmi.RemoteException

startSKDODMERUN

long startSKDODMERUN(long skdProjectId,
                     java.lang.String user,
                     java.lang.String status)
              throws MXException,
                     java.rmi.RemoteException

Add "optimization running" for the passed in scenario

Parameters:

skdProjectId - skdproject unique id

Throws:

MXException

java.rmi.RemoteException

finishSKDODMERUN

void finishSKDODMERUN(long skdProjectId,
                      java.lang.String status)
               throws MXException,
                      java.rmi.RemoteException

Delete "optimization running" for the passed in scenario

Parameters:

skdProjectId - skdproject unique id

Throws:

MXException

java.rmi.RemoteException

finishSKDODMERUN

void finishSKDODMERUN(long skdProjectId,
                      java.lang.String status,
                      long skdOdmeRunId)
               throws MXException,
                      java.rmi.RemoteException

Delete "optimization running" for the passed in scenario

Parameters:

skdProjectId - skdproject unique id

Throws:

MXException

java.rmi.RemoteException

ODMEaddRunMsg

void ODMEaddRunMsg(long skdProjectId,
                   UserInfo userInfo,
                   java.lang.String message,
                   boolean key)
            throws MXException,
                   java.rmi.RemoteException

Allow sender to add a message to our map.

Parameters:

skdProjectId - skdproject unique id

msg -

Throws:

MXException

java.rmi.RemoteException

ODMEclearRunMsg

void ODMEclearRunMsg(long skdProjectId)
              throws MXException,
                     java.rmi.RemoteException

Allow sender to clear messages of our map.

Parameters:

skdProjectId - skdproject unique id

Throws:

MXException

java.rmi.RemoteException

ODMEclearCompleted

void ODMEclearCompleted()
                 throws MXException,
                        java.rmi.RemoteException

Allow sender to clear completed tasks of our map.

Throws:

MXException

java.rmi.RemoteException

setJobIDSKDODMERUN

void setJobIDSKDODMERUN(long skdOdmeRunId,
                        java.lang.String mosJobId)
                 throws MXException,
                        java.rmi.RemoteException

Updates the SKDODMERUN.MOSJOBID for the passed in parameters.

Parameters:

skdOdmeRunId - unique id of SKDODMERUN record

mosJobId - unique mos job id

Throws:

MXException

java.rmi.RemoteException

getUseCPS

boolean getUseCPS(UserInfo userInfo)
           throws java.rmi.RemoteException

Returns true if the CPS system property is set to true

Parameters:

userInfo -

Throws:

java.rmi.RemoteException

getOptimizationMosAPIBaseURL

java.lang.String getOptimizationMosAPIBaseURL(UserInfo userInfo)
                                       throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getOptimizationMosAPIKey

java.lang.String getOptimizationMosAPIKey(UserInfo userInfo)
                                   throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException