Field

Description

public statiC final

CACOPYRIGHT

Constructor

Description

public

PMService2()

Return

Operation

Description

void

clearLog()

Cleans up the log trace

java.lang.String

createDefinition(java.lang.String xml)

Creates new process definition

ActorImpl

createActor()

Creates a new actor

void

deleteActor(java.lang.String actorName)

Deletes an actor from workflow

void

deleteDefinition(java.lang.String id)

Deletes a process definition by given ID

void

deleteInstance(java.lang.String id)

Permanently removes the process instance

void

enableLogging(boolean enable)

Starts and stops logging

java.lang.String

getActor(java.lang.String actor)

Returns a single actor as an XML document

java.lang.String

getActors()

Returns all actors as an XML document

Pair[]

getConfiguration()

Returns a process manager configuration

java.lang.String

getDefinition(java.lang.String id, boolean lock)

Returns the specified process definition

ProcessDefinitionDescriptor

getDefinitionDescriptor(java.lang.String id)

Returns the Process Definition Descriptor for the specified process definition

ProcessDefinitionDescriptor[]

getDefinitions()

Returns an array of process definition descriptors

Pair[]

getExternalVariables(java.lang.String processId)

Returns the external variables for a process

Attribute[]

getInputParameters(java.lang.String id)

Returns input parameters for a process definition

java.lang.String

getInstance(java.lang.String id)

Returns string containing the complete Process Instance object for the specified process instance expressed as an XML document

java.lang.String

getInstanceDetails(java.lang.String id)

Returns string containing the "Process Instance details" for the specified process instance expressed as an XML document. The returned value contains bare-minimum details of a given process-instance compared to getInstance(String) method above, for example, in PMService2.

This method does exactly what the PMService.getInstance(String) method does.

com.ejbtech.process.HistoryRecord[]

getInstanceHistory(java.lang.String id)

Returns the history of an instance as an array of HistoryRecords

byte[ ]

getInstanceImage(final String instanceid,TransmissionType tp,ImageType it)

Returns a process instance status image

ProcessInstanceDescriptor[]

getInstances(java.lang.String definitionId, long from, long to)

Returns an array of instances for the process definition

ProcessInstanceDescriptorBean[]

getInstancesByStatus()

Returns an array of instances for the process definition selected by status

com.ejbtech.processengine.WorkItem[]

getInstanceWorkItems(java.lang.String id, boolean showCompleted)

Returns all the workitems for a particular instance

LogEntry[]

getLog()

Returns the user's log

java.lang.String

getLoginName()

Returns the username associated with this session

Attribute[]

getResults(java.lang.String id)

Returns process execution results as an array of attributes

ProcessDefinitionDescriptor[]

getRunningDefinitions()

Returns an array of all the definitions that have instances in the system

java.lang.String

getStatus(java.lang.String processid)

Returns the status code of a process

java.lang.String

getStatusCode(java.lang.String processid)

Returns the status code of a process

boolean

hasDefinitionPermission(java.lang.String permissionName, java.lang.String definitionId)

Checks if the current user has a permission on a given definition

boolean

hasGlobalPermission(java.lang.String permissionName)

Checks if the current user has the given global permission

boolean

hasInstancePermission(java.lang.String permissionName, java.lang.String instanceId)

Checks if the current user has a permission on a given instance

boolean

isLoggingEnabled()

Returns true if the Process Manager Server enabled logging and false otherwise

boolean

isSessionValid()

Checks if this PMService2 session is still valid

void

lock(java.lang.String id)

Locks the process definition or process instance identified

void

logIn(java.lang.String user, java.lang.String password)

Logs in the specified user into the process manager

void

loginToken(java.lang.String token)

Logs in the specified user into the process manager using a token from eTrust IAM Toolkit

void

logOut()

Logs out of the process manager session

void

purgeAsynchronouslyForCompletedWith
Stats

Permanently deletes all process instances that are created from the specified process definition and also the associated data from the STATS table and run within the specified time period

Integer

purgeSynchronouslyForCompletedWith
Stats

Permanently deletes all process instances created from the specified process definition that started or completed between the specified dates and also the associated data from the STATS table and run within the specified time period

void

purgeInstances(java.lang.String definitionId, long from, long to)

Permanently deletes all process instances created from the specified process definition, and started between the dates specified

void

purgeInstancesAsynchronously

Permanently deletes all process instances created from the specified process definition that started or completed between the specified dates

Integer

purgeInstancesSynchronously

Permanently deletes all process instances created from the specified process definition that started or completed between the specified dates

java.lang.String[]

putActors(java.lang.String actorXML)

Puts actors into the workflow database

void

putConfiguration(Pair[] configuration)

Sets a process manager configuration

java.lang.String

putDefinition(java.lang.String xml)

Updates an existing process definition or creates a new process definition if the process definition id is null

void

resumeInstance(java.lang.String id)

Resumes the specified process instance, putting it back into the running state

void

setExternalVariables(java.lang.String processId, Pair[] externals)

Sets the external variables for a process

void

setLocale

Creates locale object from language and country for use in logging event messages and history

java.lang.String

start(java.lang.String definitionId, com.ejbtech.processengine.Parameter[] parameters)

Instantiates the specified process definition

void

suspendInstance(java.lang.String id)

Suspends the specified process instance

void

terminateInstance(java.lang.String id)

Terminates the specified process instance

void

unlock(java.lang.String id)

Unlocks the process definition or process instance identified

void

updateActor(java.lang.String actorXML, java.lang.String actorName)

Updates an actor in workflow

Method

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