WebSphere MQ Workflow 3.4.0 Java Generic API Test / Prototyping Tool
[prev][next][parent][TOC]
ProcessInstance
===SYNTAX FOR PROCESS INSTANCE APIs=====================================
ProcessInstance.auditMode
processInstanceHdl i
| processInstanceArrayHdl i
xpValue NOT_SET
| NO_AUDIT
| CONDENSED
| FULL
| FILTER
End
ProcessInstance.category
processInstanceHdl i
| processInstanceArrayHdl i
xpValue "value" | null
End
ProcessInstance.creationTime
processInstanceHdl i
| processInstanceArrayHdl i
dateTimeHdl n
xpValue "dt_value"
End
ProcessInstance.creator
processInstanceHdl i
| processInstanceArrayHdl i
xpValue "value"
End
ProcessInstance.delete
processInstanceHdl i
| processInstanceArrayHdl i
xpFmcException FMC_OK
End
ProcessInstance.description
processInstanceHdl i
| processInstanceArrayHdl i
xpValue "value" | null
End
ProcessInstance.documentation
processInstanceHdl i
| processInstanceArrayHdl i
xpValue "value" | null
End
ProcessInstance.endTime
processInstanceHdl i
| processInstanceArrayHdl i
dateTimeHdl n
xpValue "dt_value" | null
End
ProcessInstance.globalContainer /* version 3.3.2 or > */
processInstanceHdl i
readOnlyContainerHdl n
xpFmcException FMC_OK
End
ProcessInstance.icon
processInstanceHdl i
| processInstanceArrayHdl i
xpValue "value"
End
ProcessInstance.inContainer
processInstanceHdl i
readWriteContainerHdl n
xpFmcException FMC_OK
End
ProcessInstance.inContainerName
processInstanceHdl i
| processInstanceArrayHdl i
xpValue "value"
End
ProcessInstance.inContainerNeeded
processInstanceHdl i
| processInstanceArrayHdl i
xpValue true | false
End
ProcessInstance.isComplete
processInstanceHdl i
| processInstanceArrayHdl i
xpValue true | false
End
ProcessInstance.isEmpty
processInstanceHdl i
| processInstanceArrayHdl i
xpValue true | false
End
ProcessInstance.lastModificationTime
processInstanceHdl i
| processInstanceArrayHdl i
dateTimeHdl n
xpValue "dt_value"
End
ProcessInstance.lastStateChangeTime
processInstanceHdl i
| processInstanceArrayHdl i
dateTimeHdl n
xpValue "dt_value"
End
ProcessInstance.name
processInstanceHdl i
| processInstanceArrayHdl i
xpValue "value"
| xpValueLike "like_value"
End
ProcessInstance.notificationTime
processInstanceHdl i
| processInstanceArrayHdl i
dateTimeHdl n
xpValue "dt_value" | null
End
ProcessInstance.notifiedPerson
processInstanceHdl i
| processInstanceArrayHdl i
xpValue "value" | null
End
ProcessInstance.obtainMonitor /* deprecated (version 3.3.0) */
processInstanceHdl i
deep true | false
processInstanceMonitorHdl n
xpFmcException FMC_OK
End
ProcessInstance.obtainProcessMonitor /* version 3.3.0 or > */
processInstanceHdl i
deep true | false
instanceMonitorHdl n
xpFmcException FMC_OK
End
ProcessInstance.organizationName
processInstanceHdl i
| processInstanceArrayHdl i
xpValue "value" | null
End
ProcessInstance.outContainer /* version 3.2.1 SP1 or > */
processInstanceHdl i
readOnlyContainerHdl n
xpFmcException FMC_OK
End
ProcessInstance.outContainerName
processInstanceHdl i
| processInstanceArrayHdl i
xpValue "value"
End
ProcessInstance.parentName
processInstanceHdl i
| processInstanceArrayHdl i
xpValue "value" | null
| xpValueLike "like_value"
End
ProcessInstance.persistentOid
processInstanceHdl i
| processInstanceArrayHdl i
persistentOidHdl n
[ persistentOidOutputFileSpec "fileSpec" ]
xpValue "value"
End
ProcessInstance.processAdmin
processInstanceHdl i
| processInstanceArrayHdl i
xpValue "value" | null
End
ProcessInstance.processContext /* version 3.3.2 or > */
processInstanceHdl i
| processInstanceArrayHdl i
xpValue "value" | null
End
ProcessInstance.processTemplateName
processInstanceHdl i
| processInstanceArrayHdl i
xpValue "value"
End
ProcessInstance.refresh
processInstanceHdl i
| processInstanceArrayHdl i
xpFmcException FMC_OK
End
ProcessInstance.restart
processInstanceHdl i
| processInstanceArrayHdl i
xpFmcException FMC_OK
End
ProcessInstance.resume
processInstanceHdl i
| processInstanceArrayHdl i
deep true | false
xpFmcException FMC_OK
End
ProcessInstance.roleName
processInstanceHdl i
| processInstanceArrayHdl i
xpValue "value" | null
End
ProcessInstance.setDescription
processInstanceHdl i
| processInstanceArrayHdl i
description "value" | null
xpFmcException FMC_OK
End
ProcessInstance.setProcessAdmin /* version 3.4.0 or > */
processInstanceHdl i
| processInstanceArrayHdl i
userID "value" | "<CL-VALUE>"
xpFmcException FMC_OK
End
ProcessInstance.setName
processInstanceHdl i
| processInstanceArrayHdl i
name "value"
xpFmcException FMC_OK
End
ProcessInstance.start
processInstanceHdl i
| processInstanceArrayHdl i
xpFmcException FMC_OK
End
ProcessInstance.start2
processInstanceHdl i
| processInstanceArrayHdl i
readWriteContainerHdl i | null
xpFmcException FMC_OK
End
ProcessInstance.start3 /* version 3.3.2 or > */
processInstanceHdl i
| processInstanceArrayHdl i
readWriteContainerHdl i | null
processContext "value" | null
xpFmcException FMC_OK
End
ProcessInstance.starter
processInstanceHdl i
| processInstanceArrayHdl i
xpValue "value" | null
End
ProcessInstance.startTime
processInstanceHdl i
| processInstanceArrayHdl i
dateTimeHdl n
xpValue "dt_value" | null
End
ProcessInstance.state
processInstanceHdl i
| processInstanceArrayHdl i
xpValue DELETED
| FINISHED
| READY
| RUNNING
| SUSPENDED
| SUSPENDING
| TERMINATED
| TERMINATING
| UNDEFINED
End
ProcessInstance.stateOfNotification
processInstanceHdl i
| processInstanceArrayHdl i
xpValue NO_NOTIFICATION
| NOT_SET
| PROCESS_NOTIFICATION
End
ProcessInstance.suspend
processInstanceHdl i
| processInstanceArrayHdl i
deep true | false
xpFmcException FMC_OK
End
ProcessInstance.suspend2
processInstanceHdl i
| processInstanceArrayHdl i
dateTimeHdl i
deep true | false
xpFmcException FMC_OK
End
ProcessInstance.suspensionExpirationTime
processInstanceHdl i
| processInstanceArrayHdl i
dateTimeHdl n
xpValue "dt_value" | null
End
ProcessInstance.suspensionTime
processInstanceHdl i
| processInstanceArrayHdl i
dateTimeHdl n
xpValue "dt_value" | null
End
ProcessInstance.systemGroupName
processInstanceHdl i
| processInstanceArrayHdl i
xpValue "value"
End
ProcessInstance.systemName
processInstanceHdl i
| processInstanceArrayHdl i
xpValue "value"
End
ProcessInstance.terminate
processInstanceHdl i
| processInstanceArrayHdl i
xpFmcException FMC_OK
End
ProcessInstance.topLevelName
processInstanceHdl i
| processInstanceArrayHdl i
xpValue "value"
| xpValueLike "like_value"
End
ProcessInstance.validFromTime /* version 3.3.2 or > */
processInstanceHdl i
| processInstanceArrayHdl i
dateTimeHdl n
xpValue "dt_value"
End