WebSphere MQ Workflow 3.4.0 Java Generic API Test / Prototyping Tool

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

Item

===SYNTAX FOR ITEM APIs=================================================

Item.category
  itemHdl                           i
  | itemArrayHdl                    i
  xpValue                           "value" | null
End

Item.creationTime
  itemHdl                           i
  | itemArrayHdl                    i
  dateTimeHdl                       n
  xpValue                           "dt_value"
End

Item.delete
  itemHdl                           i
  | itemArrayHdl                    i
  xpFmcException                    FMC_OK
End

Item.description
  itemHdl                           i
  | itemArrayHdl                    i
  xpValue                           "value" | null
End

Item.documentation
  itemHdl                           i
  | itemArrayHdl                    i
  xpValue                           "value" | null
End

Item.endTime
  itemHdl                           i
  | itemArrayHdl                    i
  dateTimeHdl                       n
  xpValue                           "dt_value" | null
End

Item.icon
  itemHdl                           i
  | itemArrayHdl                    i
  xpValue                           "value"
End

Item.inContainerName
  itemHdl                           i
  | itemArrayHdl                    i
  xpValue                           "value"
End

Item.isComplete
  itemHdl                           i
  | itemArrayHdl                    i
  xpValue                           true | false
End

Item.isEmpty
  itemHdl                           i
  | itemArrayHdl                    i
  xpValue                           true | false
End

Item.kind
  itemHdl                           i
  | itemArrayHdl                    i
  xpValue                           FIRST_ACTIVITY_INSTANCE_NOTIFICATION
                                  | PROCESS_INSTANCE_NOTIFICATION
                                  | SECOND_ACTIVITY_INSTANCE_NOTIFICATION
                                  | UNKNOWN
                                  | WORK_ITEM
End

Item.lastModificationTime
  itemHdl                           i
  | itemArrayHdl                    i
  dateTimeHdl                       n
  xpValue                           "dt_value"
End

Item.name
  itemHdl                           i
  | itemArrayHdl                    i
  xpValue                           "value"
End

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

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

Item.outContainerName
  itemHdl                           i
  | itemArrayHdl                    i
  xpValue                           "value"
End

Item.owner
  itemHdl                           i
  | itemArrayHdl                    i
  xpValue                           "value"
End

Item.persistentOid
  itemHdl                           i
  | itemArrayHdl                    i
  persistentOidHdl                  n
  [ persistentOidOutputFileSpec     "fileSpec" ]
  xpValue                           "value"
End

Item.persistentOidOfProcessInstance              /* version 3.2.2 or > */
  itemHdl                           i
  | itemArrayHdl                    i
  persistentOidHdl                  n
  [ persistentOidOutputFileSpec     "fileSpec" ]
  xpValue                           "value"
End

Item.processAdmin
  itemHdl                           i
  | itemArrayHdl                    i
  xpValue                           "value"
End

Item.processInstance
  itemHdl                           i
  processInstanceHdl                n
  xpFmcException                    FMC_OK
End

Item.processInstanceName
  itemHdl                           i
  | itemArrayHdl                    i
  xpValue                           "value"
  | xpValueLike                     "like_value"
End

Item.processInstanceState
  itemHdl                           i
  | itemArrayHdl                    i
  xpValue                           DELETED
                                  | FINISHED
                                  | READY
                                  | RUNNING
                                  | SUSPENDED
                                  | SUSPENDING
                                  | TERMINATED
                                  | TERMINATING
                                  | UNDEFINED
End

Item.processInstanceSystemGroupName
  itemHdl                           i
  | itemArrayHdl                    i
  xpValue                           "value"
End

Item.processInstanceSystemName
  itemHdl                           i
  | itemArrayHdl                    i
  xpValue                           "value"
End

Item.receivedAs
  itemHdl                           i
  | itemArrayHdl                    i
  xpValue                           BY_TRANSFER
                                  | NORMAL
                                  | NOT_SPECIFIED
                                  | PROCESS_ADMINISTRATOR
                                  | SUBSTITUTE
                                  | SYSTEM_ADMINISTRATOR
End

Item.receivedTime
  itemHdl                           i
  | itemArrayHdl                    i
  dateTimeHdl                       n
  xpValue                           "dt_value"
End

Item.refresh
  itemHdl                           i
  | itemArrayHdl                    i
  xpFmcException                    FMC_OK
End

Item.setDescription
  itemHdl                           i
  | itemArrayHdl                    i
  description                       "value" | null
  xpFmcException                    FMC_OK
End

Item.setName
  itemHdl                           i
  | itemArrayHdl                    i
  name                              "value" | null
  xpFmcException                    FMC_OK
End

Item.startTime
  itemHdl                           i
  | itemArrayHdl                    i
  dateTimeHdl                       n
  xpValue                           "dt_value" | null
End

Item.transfer
  itemHdl                           i
  | itemArrayHdl                    i
  userID                            "value"
  xpFmcException                    FMC_OK
End