WebSphere MQ Workflow 3.4.0 Java Generic API Test / Prototyping Tool
[prev][next][parent][TOC]
WorkItem
===SYNTAX FOR WORK ITEM APIs============================================
WorkItem.activityInstance /* version 3.2.2 or > */
workItemHdl i
activityInstanceHdl n
xpFmcException FMC_OK
End
WorkItem.activityKind
workItemHdl i
| workItemArrayHdl i
xpValue BLOCK
| NOT_SET
| PROCESS
| PROGRAM
End
WorkItem.cancelCheckOut
workItemHdl i
| workItemArrayHdl i
xpFmcException FMC_OK
End
WorkItem.checkIn
workItemHdl i
readWriteContainerHdl i
returnCode int
xpFmcException FMC_OK
End
WorkItem.checkOut
workItemHdl i
| workItemArrayHdl i
readOnlyContainerHdl n
xpFmcException FMC_OK
End
WorkItem.checkOut2
workItemHdl i
| workItemArrayHdl i
requestedData ALL_DEFINITIONS
| COMMON_DATA_ONLY
| NOT_SET
| SPECIFIED_DEFINITIONS
platform AIX
| HP_UX
| NOT_SPECIFIED
| OS2
| OS390
| SOLARIS
| WINDOWS_95
| WINDOWS_NT
programDataHdl n
xpFmcException FMC_OK
End
WorkItem.errorReason
workItemHdl i
errorHdl n
xpValue null
End
WorkItem.exitCondition
workItemHdl i
| workItemArrayHdl i
xpValue "value"
End
WorkItem.expirationTime /* version 3.3.0 or > */
workItemHdl i
| workItemArrayHdl i
dateTimeHdl n
xpValue "dt_value" | null
End
WorkItem.finish
workItemHdl i
| workItemArrayHdl i
xpFmcException FMC_OK
End
WorkItem.firstNotificationTime
workItemHdl i
| workItemArrayHdl i
dateTimeHdl n
xpValue "dt_value" | null
End
WorkItem.forceFinish
workItemHdl i
| workItemArrayHdl i
xpFmcException FMC_OK
End
WorkItem.forceFinish2 /* version 3.3.0 or > */
workItemHdl i
| workItemArrayHdl i
readOnlyContainerHdl i
| readWriteContainerHdl i
xpFmcException FMC_OK
End
WorkItem.forceRestart
workItemHdl i
| workItemArrayHdl i
xpFmcException FMC_OK
End
WorkItem.forceRestart2 /* version 3.3.0 or > */
workItemHdl i
| workItemArrayHdl i
readOnlyContainerHdl i
| readWriteContainerHdl i
xpFmcException FMC_OK
End
WorkItem.implementation
workItemHdl i
| workItemArrayHdl i
xpValue "value" | null
End
WorkItem.inContainer
workItemHdl i
readOnlyContainerHdl n
xpFmcException FMC_OK
End
WorkItem.manualExitMode
workItemHdl i
| workItemArrayHdl i
xpValue true | false
End
WorkItem.manualStartMode
workItemHdl i
| workItemArrayHdl i
xpValue true | false
End
WorkItem.outContainer
workItemHdl i
readWriteContainerHdl n
xpFmcException FMC_OK
End
WorkItem.persistentOidOfActivityInstance /* version 3.2.2 or > */
workItemHdl i
| workItemArrayHdl i
persistentOidHdl n
[ persistentOidOutputFileSpec "fileSpec" ]
xpValue "value"
End
WorkItem.priority
workItemHdl i
| workItemArrayHdl i
xpValue int
End
WorkItem.restart
workItemHdl i
| workItemArrayHdl i
xpFmcException FMC_OK
End
WorkItem.secondNotificationTime
workItemHdl i
| workItemArrayHdl i
dateTimeHdl n
xpValue "dt_value" | null
End
WorkItem.staff
workItemHdl i
| workItemArrayHdl i
stringArrayHdl n
xpValue "value1;value2;..."
End
WorkItem.start
workItemHdl i
| workItemArrayHdl i
xpFmcException FMC_OK
End
WorkItem.startCondition
workItemHdl i
| workItemArrayHdl i
xpValue "value"
End
WorkItem.startTool
workItemHdl i
| workItemArrayHdl i
toolName "value"
xpFmcException FMC_OK
End
WorkItem.state
workItemHdl i
| workItemArrayHdl i
xpValue CHECKED_OUT
| DELETED
| DISABLED
| EXECUTED
| FINISHED
| FORCE_FINISHED
| IN_ERROR
| PLANNING
| READY
| RUNNING
| SUSPENDED
| SUSPENDING
| TERMINATED
| TERMINATING
| UNDEFINED
| EXPIRED
End
WorkItem.stateOfNotification
workItemHdl i
| workItemArrayHdl i
xpValue FIRST_NOTIFICATION
| NO_NOTIFICATION
| NOT_SPECIFIED
| SECOND_NOTIFICATION
End
WorkItem.supportTools
workItemHdl i
| workItemArrayHdl i
stringArrayHdl n
xpValue "value1;value2;..." | null
End
WorkItem.terminate
workItemHdl i
| workItemArrayHdl i
xpFmcException FMC_OK
End
---extends Item---------------------------------------------------------
WorkItem.category
workItemHdl i
| workItemArrayHdl i
xpValue "value" | null
End
WorkItem.creationTime
workItemHdl i
| workItemArrayHdl i
dateTimeHdl n
xpValue "dt_value"
End
WorkItem.delete
workItemHdl i
| workItemArrayHdl i
xpFmcException FMC_OK
End
WorkItem.description
workItemHdl i
| workItemArrayHdl i
xpValue "value" | null
End
WorkItem.documentation
workItemHdl i
| workItemArrayHdl i
xpValue "value" | null
End
WorkItem.endTime
workItemHdl i
| workItemArrayHdl i
dateTimeHdl n
xpValue "dt_value" | null
End
WorkItem.icon
workItemHdl i
| workItemArrayHdl i
xpValue "value"
End
WorkItem.inContainerName
workItemHdl i
| workItemArrayHdl i
xpValue "value"
End
WorkItem.isComplete
workItemHdl i
| workItemArrayHdl i
xpValue true | false
End
WorkItem.isEmpty
workItemHdl i
| workItemArrayHdl i
xpValue true | false
End
WorkItem.kind
workItemHdl i
| workItemArrayHdl i
xpValue FIRST_ACTIVITY_INSTANCE_NOTIFICATION
| PROCESS_INSTANCE_NOTIFICATION
| SECOND_ACTIVITY_INSTANCE_NOTIFICATION
| UNKNOWN
| WORK_ITEM
End
WorkItem.lastModificationTime
workItemHdl i
| workItemArrayHdl i
dateTimeHdl n
xpValue "dt_value"
End
WorkItem.name
workItemHdl i
| workItemArrayHdl i
xpValue "value"
End
WorkItem.obtainProcessInstanceMonitor /* deprecated (version 3.3.0) */
workItemHdl i
deep true | false
processInstanceMonitorHdl n
xpFmcException FMC_OK
End
WorkItem.obtainProcessMonitor /* version 3.3.0 or > */
workItemHdl i
deep true | false
instanceMonitorHdl n
xpFmcException FMC_OK
End
WorkItem.outContainerName
workItemHdl i
| workItemArrayHdl i
xpValue "value"
End
WorkItem.owner
workItemHdl i
| workItemArrayHdl i
xpValue "value"
End
WorkItem.persistentOid
workItemHdl i
| workItemArrayHdl i
persistentOidHdl n
[ persistentOidOutputFileSpec "fileSpec" ]
xpValue "value"
End
WorkItem.persistentOidOfProcessInstance /* version 3.2.2 or > */
workItemHdl i
| workItemArrayHdl i
persistentOidHdl n
[ persistentOidOutputFileSpec "fileSpec" ]
xpValue "value"
End
WorkItem.processAdmin
workItemHdl i
| workItemArrayHdl i
xpValue "value"
End
WorkItem.processInstance
workItemHdl i
processInstanceHdl n
xpFmcException FMC_OK
End
WorkItem.processInstanceName
workItemHdl i
| workItemArrayHdl i
xpValue "value"
| xpValueLike "like_value"
End
WorkItem.processInstanceState
workItemHdl i
| workItemArrayHdl i
xpValue DELETED
| FINISHED
| READY
| RUNNING
| SUSPENDED
| SUSPENDING
| TERMINATED
| TERMINATING
| UNDEFINED
End
WorkItem.processInstanceSystemGroupName
workItemHdl i
| workItemArrayHdl i
xpValue "value"
End
WorkItem.processInstanceSystemName
workItemHdl i
| workItemArrayHdl i
xpValue "value"
End
WorkItem.receivedAs
workItemHdl i
| workItemArrayHdl i
xpValue BY_TRANSFER
| NORMAL
| NOT_SPECIFIED
| PROCESS_ADMINISTRATOR
| SUBSTITUTE
| SYSTEM_ADMINISTRATOR
End
WorkItem.receivedTime
workItemHdl i
| workItemArrayHdl i
dateTimeHdl n
xpValue "dt_value"
End
WorkItem.refresh
workItemHdl i
| workItemArrayHdl i
xpFmcException FMC_OK
End
WorkItem.setDescription
workItemHdl i
| workItemArrayHdl i
description "value" | null
xpFmcException FMC_OK
End
WorkItem.setName
workItemHdl i
| workItemArrayHdl i
name "value" | null
xpFmcException FMC_OK
End
WorkItem.startTime
workItemHdl i
| workItemArrayHdl i
dateTimeHdl n
xpValue "dt_value" | null
End
WorkItem.transfer
workItemHdl i
| workItemArrayHdl i
userID "value"
xpFmcException FMC_OK
End