psdi.workflow

Class WorkFlowService

java.lang.Object

psdi.server.AppService

psdi.workflow.WorkFlowService

All Implemented Interfaces:

java.rmi.Remote, MboServerInterface, MaxRemoteProxy, AppServiceRemote, Dependable, Service, ServiceRemote, FixedLoggerNames, FixedLoggers, WorkFlowServiceRemote

public class WorkFlowService
extends AppService
implements WorkFlowServiceRemote

Workflow service object.

Author:

neville

Field Summary

Fields inherited from interface psdi.workflow.WorkFlowServiceRemote

LOGGERNAME_WORKFLOW

Fields inherited from interface psdi.util.logging.FixedLoggers

APPLOGGER, CRONTASKLOGGER, CRONTASKMGRLOGGER, CRONTASKMGRSQLLOGGER, DBCONNECTIONLOGGER, DDLOGGER, DMLOGGER, EVENTLOGGER, EXCEPTIONLOGGER, MAILLOGGER, MAXIMOLOGGER, MTLOGGER, NULLMBOPOINTER, SECURITY, SENDFAILEDLOGGER, SERVICELOGGER, SQLLOGGER

Fields inherited from interface psdi.util.logging.FixedLoggerNames

appenderPrefix, LOGGERNAME_APP, LOGGERNAME_CRONTASK, LOGGERNAME_CRONTASKMGR, LOGGERNAME_DBCONNECTION, LOGGERNAME_DD, LOGGERNAME_DM, LOGGERNAME_DMPREVIEW, LOGGERNAME_EVENT, LOGGERNAME_EXCEPTION, LOGGERNAME_MAIL, LOGGERNAME_MAXIMO, LOGGERNAME_MT, LOGGERNAME_NULLMBOPOINTER, LOGGERNAME_SECURITY, LOGGERNAME_SENDFAILED, LOGGERNAME_SERVICE, LOGGERNAME_SQL, LOGGERNAME_SQL_CRONTASKMGR, LOGGERNAME_TXN, loggerPrefix

Constructor Summary

Constructors

Constructor and Description
WorkFlowService() Constructor
WorkFlowService(MXServer mxServer) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	completeAssignment(WFAssignmentRemote assign, java.lang.String memo, boolean accepted) Completes a workflow assignment in the background.
void	destroy() Release system resources.
boolean	evaluateCondition(Mbo onBehalfOf, java.lang.String customclass, java.lang.String condition, MboRemote mbo) Evaulates a condition.
WFInstanceSetRemote	getActiveInstances(MboRemote mbo) Returns all active instances on a Mbo.
java.lang.String	getDefaultAppForObject(UserInfo ui, java.lang.String objectName) Find the name of an application that has as it's main object the value given.
MXLogger	getWFLogger() Returns a logger to log workflow messages
MXLogger	getWFLogger(Mbo mbo) Returns a logger to log workflow messages related to a business object.
void	init() Start up the AutoInit cache.
void	initiateWorkflow(java.lang.String processName, MboRemote target) Initiates a workflow process on the target Mbo.
boolean	isActiveProcess(java.lang.String processName, java.lang.String mboName, UserInfo ui) Test that an active process exists with the given name.
void	validateCondition(MboRemote onBehalfOf, java.lang.String customAttr, java.lang.String condAttr) Checks the validity of the condition or condition class.

Methods inherited from class psdi.server.AppService

checkSecurity, configure, freeDBConnection, freeMboSet, getCriteria, getCurrentState, getDBConnection, getLiveObjCount, getLoad, getMaximoDD, getMaxVar, getMboSet, getMXServer, getName, getProfile, getProxy, getSchemaOwner, getServiceInfo, getServiceLogger, getSetForRelationship, getSetFromKeys, getStateCmdList, getStateList, getURL, initCriteriaList, isAppService, isRunning, isSingletonService, restart, setProxy, setRunning, setURL, verifyUser, verifyUser

Methods inherited from class java.lang.Object

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

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

Constructor Detail

WorkFlowService

public WorkFlowService()
                throws java.rmi.RemoteException

Constructor

Throws:

java.rmi.RemoteException

WorkFlowService

public WorkFlowService(MXServer mxServer)
                throws java.rmi.RemoteException

Constructor

Parameters:

srvEnv - -- the "Server Environment" this Service is being created in.

Throws:

java.rmi.RemoteException

Method Detail

init

public void init()

Start up the AutoInit cache.

Specified by:

init in interface Service

Overrides:

init in class AppService

See Also:

Service.init()

destroy

public void destroy()

Description copied from interface: Service

Release system resources. The object should release all system resources. This will be called only once and is called to prepare the object for finalization.

Specified by:

destroy in interface Service

Overrides:

destroy in class AppService

See Also:

Service

getActiveInstances

public WFInstanceSetRemote getActiveInstances(MboRemote mbo)
                                       throws MXException,
                                              java.rmi.RemoteException

Returns all active instances on a Mbo.

Specified by:

getActiveInstances in interface WorkFlowServiceRemote

Parameters:

mbo - The mbo to return instances for.

Returns:

The set of active instances. Returns an empty set if there are no active instances on the mbo.

Throws:

MXException

java.rmi.RemoteException

See Also:

getActiveInstances(MboRemote)

validateCondition

public void validateCondition(MboRemote onBehalfOf,
                     java.lang.String customAttr,
                     java.lang.String condAttr)
                       throws java.rmi.RemoteException,
                              MXException

Checks the validity of the condition or condition class. Used during process validation. Assumes only one of customclass & condition will have a value. Will not throw an exception if both don't have a value.

Parameters:

onBehalfOf - The Mbo performing this validation test.

customclass - The custom class name used for the condition.

condition - The condition.

Throws:

java.rmi.RemoteException

MXException

evaluateCondition

public boolean evaluateCondition(Mbo onBehalfOf,
                        java.lang.String customclass,
                        java.lang.String condition,
                        MboRemote mbo)
                          throws MXException,
                                 java.rmi.RemoteException

Evaulates a condition. Uses the customclass if provided, otherwise evaluates the condition. The condition is evaluated using the Parser Service.

Parameters:

onBehalfOf - The Mbo performing this evaluation. Need for error logging.

customclass - If specified, an instance of the class is created and evaluated

condition - The condition.

mbo - This mbo is passed to the customclass or is the source of values for the condition.

Returns:

The result of the evaluation.

Throws:

MXException

java.rmi.RemoteException

initiateWorkflow

public void initiateWorkflow(java.lang.String processName,
                    MboRemote target)
                      throws MXException,
                             java.rmi.RemoteException

Initiates a workflow process on the target Mbo. This method should only be used where there the process is written so that there is no user interaction before reaching a stopping point - either a stop or task node. Calling this method should be the last thing done to the Mbo. The Mbo will be saved by the workflow process, most likely.

This method makes use of the InitiateWorkflow virtual set.
If the process requires user interaction, like a manual input, then an error will be logged and an exception thrown.
If the process name is not valid or any other MXException, then an error will be logged and an exception thrown.

Specified by:

initiateWorkflow in interface WorkFlowServiceRemote

Parameters:

processName - The name of the process to initiate.

target - The Mbo to initiate workflow on.

Throws:

MXApplicationException - Thrown with "workflow", "BgInitFailure" if the workflow can't be initiated in the background. The nested exception will have additional details.

MXException

java.rmi.RemoteException

See Also:

Similar to this.

getWFLogger

public MXLogger getWFLogger()
                     throws MXException,
                            java.rmi.RemoteException

Returns a logger to log workflow messages

Specified by:

getWFLogger in interface WorkFlowServiceRemote

Returns:

MXLogger a logger to log workflow messages.

Throws:

MXException

java.rmi.RemoteException

See Also:

getWFLogger()

getWFLogger

public MXLogger getWFLogger(Mbo mbo)
                     throws MXException,
                            java.rmi.RemoteException

Returns a logger to log workflow messages related to a business object.

Specified by:

getWFLogger in interface WorkFlowServiceRemote

Parameters:

Mbo - the business object who you want the logger for.

Returns:

MXLogger a logger to log workflow messages related to a business object.

Throws:

MXException

java.rmi.RemoteException

See Also:

getWFLogger(Mbo mbo)

completeAssignment

public void completeAssignment(WFAssignmentRemote assign,
                      java.lang.String memo,
                      boolean accepted)
                        throws MXException,
                               java.rmi.RemoteException

Completes a workflow assignment in the background. This method should only be used where there the process is written so that there is no user interaction before reaching a stopping point - either a stop or task node. Calling this method should be the last thing done to the Mbo. The Mbo will be saved by the workflow process, most likely.

If the process requires user interaction, like a manual input, then an error will be logged and an exception thrown.
If the process name is not valid or any other MXException, then an error will be logged and an exception thrown.

Specified by:

completeAssignment in interface WorkFlowServiceRemote

Parameters:

assign - The assignment to complete.

memo - The memo for the assignment complete

accepted - Determines whether the accept or reject action is used.

Throws:

MXApplicationException - Thrown with "workflow", "BgCompFailure" if the workflow can't be initiated in the background. The nested exception will have additional details.

MXException

java.rmi.RemoteException

See Also:

Similar to this.

isActiveProcess

public boolean isActiveProcess(java.lang.String processName,
                      java.lang.String mboName,
                      UserInfo ui)
                        throws MXException,
                               java.rmi.RemoteException

Test that an active process exists with the given name.

Specified by:

isActiveProcess in interface WorkFlowServiceRemote

Parameters:

processName - Name of the process to check for

mbo - The type of mbo is the type of process that should be active

ui - Used to get data from the database.

Returns:

true if there is an active process with that name

Throws:

MXException

java.rmi.RemoteException

See Also:

psdi.workflow.WorkFlowService#isActiveProcess(String, String)

getDefaultAppForObject

public java.lang.String getDefaultAppForObject(UserInfo ui,
                                      java.lang.String objectName)
                                        throws MXException,
                                               java.rmi.RemoteException

Find the name of an application that has as it's main object the value given.

Specified by:

getDefaultAppForObject in interface WorkFlowServiceRemote

Parameters:

ui - Used to get data from the database.

objectName - Name of the Object

Returns:

Name of an application for that object, or null if there is none.

Throws:

MXException

java.rmi.RemoteException

See Also:

getDefaultAppForObject(UserInfo,String)