WebSphere MQ Workflow 3.4.0 Java Generic API Test / Prototyping Tool

[prev][next][parent][TOC]

ActivityInstance

===SYNTAX ACTIVITY INSTANCE APIs========================================

ActivityInstance.activationTime
  activityInstanceHdl               i
  | activityInstanceArrayHdl        i
  dateTimeHdl                       n
  xpValue                           "dt_value" | null
End

ActivityInstance.category
  activityInstanceHdl               i
  | activityInstanceArrayHdl        i
  xpValue                           "value" | null
End

ActivityInstance.description
  activityInstanceHdl               i
  | activityInstanceArrayHdl        i
  xpValue                           "value" | null
End

ActivityInstance.documentation
  activityInstanceHdl               i
  | activityInstanceArrayHdl        i
  xpValue                           "value" | null
End

ActivityInstance.endTime
  activityInstanceHdl               i
  | activityInstanceArrayHdl        i
  dateTimeHdl                       n
  xpValue                           "dt_value" | null
End

ActivityInstance.errorReason
  activityInstanceHdl               i
  errorHdl                          n
  xpValue                           null
End

ActivityInstance.exitCondition
  activityInstanceHdl               i
  | activityInstanceArrayHdl        i
  xpValue                           "value"
End

ActivityInstance.expirationTime                  /* version 3.3.0 or > */
  activityInstanceHdl               i
  | activityInstanceArrayHdl        i
  dateTimeHdl                       n
  xpValue                           "dt_value" | null
End

ActivityInstance.firstNotificationTime
  activityInstanceHdl               i
  | activityInstanceArrayHdl        i
  dateTimeHdl                       n
  xpValue                           "dt_value" | null
End

ActivityInstance.firstNotifiedPersons
  activityInstanceHdl               i
  | activityInstanceArrayHdl        i
  stringArrayHdl                    n
  xpValue                           "value1;value2;..."
End

ActivityInstance.forceFinish                     /* version 3.3.0 or > */
  activityInstanceHdl               i
  | activityInstanceArrayHdl        i
  xpFmcException                    FMC_OK
End

ActivityInstance.forceFinish2                    /* version 3.3.0 or > */
  activityInstanceHdl               i
  | activityInstanceArrayHdl        i
  readOnlyContainerHdl              i
  | readWriteContainerHdl           i
  xpFmcException                    FMC_OK
End

ActivityInstance.forceRestart                    /* version 3.3.0 or > */
  activityInstanceHdl               i
  | activityInstanceArrayHdl        i
  xpFmcException                    FMC_OK
End

ActivityInstance.forceRestart2                   /* version 3.3.0 or > */
  activityInstanceHdl               i
  | activityInstanceArrayHdl        i
  readOnlyContainerHdl              i
  | readWriteContainerHdl           i
  xpFmcException                    FMC_OK
End

ActivityInstance.fullName
  activityInstanceHdl               i
  | activityInstanceArrayHdl        i
  xpValue                           "value"
End

ActivityInstance.icon
  activityInstanceHdl               i
  | activityInstanceArrayHdl        i
  xpValue                           "value"
End

ActivityInstance.implementation
  activityInstanceHdl               i
  | activityInstanceArrayHdl        i
  xpValue                           "value" | null
End

ActivityInstance.inContainer                     /* version 3.2.1 SP1 or > */
  activityInstanceHdl               i
  readOnlyContainerHdl              n
  xpFmcException                    FMC_OK
End

ActivityInstance.inContainerName
  activityInstanceHdl               i
  | activityInstanceArrayHdl        i
  xpValue                           "value"
End

ActivityInstance.isComplete
  activityInstanceHdl               i
  | activityInstanceArrayHdl        i
  xpValue                           true | false
End

ActivityInstance.isEmpty
  activityInstanceHdl               i
  | activityInstanceArrayHdl        i
  xpValue                           true | false
End

ActivityInstance.kind
  activityInstanceHdl               i
  | activityInstanceArrayHdl        i
  xpValue                           BLOCK
                                  | NOT_SET
                                  | PROCESS
                                  | PROGRAM
End

ActivityInstance.lastModificationTime
  activityInstanceHdl               i
  | activityInstanceArrayHdl        i
  dateTimeHdl                       n
  xpValue                           "dt_value"
End

ActivityInstance.lastStateChangeTime
  activityInstanceHdl               i
  | activityInstanceArrayHdl        i
  dateTimeHdl                       n
  xpValue                           "dt_value"
End

ActivityInstance.manualExitMode
  activityInstanceHdl               i
  | activityInstanceArrayHdl        i
  xpValue                           true | false
End

ActivityInstance.manualStartMode
  activityInstanceHdl               i
  | activityInstanceArrayHdl        i
  xpValue                           true | false
End

ActivityInstance.name
  activityInstanceHdl               i
  | activityInstanceArrayHdl        i
  xpValue                           "value"
End

ActivityInstance.obtainProcessInstanceMonitor    /* deprecated (version 3.3.0) */
  activityInstanceHdl               i
  deep                              true | false
  processInstanceMonitorHdl         n
  xpFmcException                    FMC_OK
End

ActivityInstance.obtainProcessMonitor            /* version 3.3.0 or > */
  activityInstanceHdl               i
  deep                              true | false
  instanceMonitorHdl                n
  xpFmcException                    FMC_OK
End

ActivityInstance.outContainer                    /* version 3.2.1 SP1 or > */
  activityInstanceHdl               i
  readOnlyContainerHdl              n
  xpFmcException                    FMC_OK
End

ActivityInstance.outContainerName
  activityInstanceHdl               i
  | activityInstanceArrayHdl        i
  xpValue                           "value"
End

ActivityInstance.persistentOid
  activityInstanceHdl               i
  | activityInstanceArrayHdl        i
  persistentOidHdl                  n
  [ persistentOidOutputFileSpec     "fileSpec" ]
  xpValue                           "value"
End

ActivityInstance.priority
  activityInstanceHdl               i
  | activityInstanceArrayHdl        i
  xpValue                           int | null
End

ActivityInstance.processAdmin
  activityInstanceHdl               i
  | activityInstanceArrayHdl        i
  xpValue                           "value" | null
End

ActivityInstance.processInstanceName
  activityInstanceHdl               i
  | activityInstanceArrayHdl        i
  xpValue                           "value"
  | xpValueLike                     "like_value"
End

ActivityInstance.processInstanceState
  activityInstanceHdl               i
  | activityInstanceArrayHdl        i
  xpValue                           DELETED
                                  | FINISHED
                                  | READY
                                  | RUNNING
                                  | SUSPENDED
                                  | SUSPENDING
                                  | TERMINATED
                                  | TERMINATING
                                  | UNDEFINED
End

ActivityInstance.processInstanceSystemGroupName
  activityInstanceHdl               i
  | activityInstanceArrayHdl        i
  xpValue                           "value"
End

ActivityInstance.processInstanceSystemName
  activityInstanceHdl               i
  | activityInstanceArrayHdl        i
  xpValue                           "value"
End

ActivityInstance.refresh                         /* version 3.3.0 or > */
  activityInstanceHdl               i
  | activityInstanceArrayHdl        i
  xpFmcException                    FMC_OK
End

ActivityInstance.secondNotificationTime
  activityInstanceHdl               i
  | activityInstanceArrayHdl        i
  dateTimeHdl                       n
  xpValue                           "dt_value" | null
End

ActivityInstance.secondNotifiedPersons
  activityInstanceHdl               i
  | activityInstanceArrayHdl        i
  stringArrayHdl                    n
  xpValue                           "value1;value2;..."
End

ActivityInstance.staff
  activityInstanceHdl               i
  | activityInstanceArrayHdl        i
  stringArrayHdl                    n
  xpValue                           "value1;value2;..."
End

ActivityInstance.startCondition
  activityInstanceHdl               i
  | activityInstanceArrayHdl        i
  xpValue                           "value"
End

ActivityInstance.starter
  activityInstanceHdl               i
  | activityInstanceArrayHdl        i
  xpValue                           "value" | null
End

ActivityInstance.startTime
  activityInstanceHdl               i
  | activityInstanceArrayHdl        i
  dateTimeHdl                       n
  xpValue                           "dt_value" | null
End

ActivityInstance.state
  activityInstanceHdl               i
  | activityInstanceArrayHdl        i
  xpValue                           CHECKED_OUT
                                  | DELETED
                                  | EXECUTED
                                  | FINISHED
                                  | FORCE_FINISHED
                                  | IN_ERROR
                                  | INACTIVE
                                  | PLANNING
                                  | READY
                                  | RUNNING
                                  | SKIPPED
                                  | SUSPENDED
                                  | SUSPENDING
                                  | TERMINATED
                                  | TERMINATING
                                  | UNDEFINED
                                  | EXPIRED
End

ActivityInstance.stateOfNotification
  activityInstanceHdl               i
  | activityInstanceArrayHdl        i
  xpValue                           FIRST_NOTIFICATION
                                  | NO_NOTIFICATION
                                  | NOT_SPECIFIED
                                  | SECOND_NOTIFICATION
End

ActivityInstance.subProcessInstance
  activityInstanceHdl               i
  processInstanceHdl                n
  xpFmcException                    FMC_OK
End

ActivityInstance.supportTools
  activityInstanceHdl               i
  | activityInstanceArrayHdl        i
  stringArrayHdl                    n
  xpValue                           "value1;value2;..." | null
End

ActivityInstance.symbolLayout
  activityInstanceHdl               i
  symbolLayoutHdl                   n
End

ActivityInstance.terminate                       /* version 3.2.1 SP2 or > */
  activityInstanceHdl               i
  | activityInstanceArrayHdl        i
  xpFmcException                    FMC_OK
End