WebSphere MQ Workflow 3.4.0 Java Generic API Test / Prototyping Tool

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

ProcessTemplate

===SYNTAX FOR PROCESS TEMPLATE APIs=====================================

ProcessTemplate.auditMode
  processTemplateHdl                i
  | processTemplateArrayHdl         i
  xpValue                           NOT_SET
                                  | NO_AUDIT
                                  | CONDENSED
                                  | FULL
                                  | FILTER
End

ProcessTemplate.category
  processTemplateHdl                i
  | processTemplateArrayHdl         i
  xpValue                           "value" | null
End

ProcessTemplate.createAndStartInstance
  processTemplateHdl                i
  | processTemplateArrayHdl         i
  instanceName                      "value" | null
  keepName                          true | false
  processInstanceHdl                n
  [ createNoObj                     int ]
  xpFmcException                    FMC_OK
End

ProcessTemplate.createAndStartInstance2
  processTemplateHdl                i
  | processTemplateArrayHdl         i
  instanceName                      "value" | null
  ReadWriteContainerHdl             i | null
  keepName                          true | false
  processInstanceHdl                n
  [ createNoObj                     int ]
  xpFmcException                    FMC_OK
End

ProcessTemplate.createAndStartInstance3    /* version 3.3.2 or > */
  processTemplateHdl                i
  | processTemplateArrayHdl         i
  instanceName                      "value" | null
  ReadWriteContainerHdl             i | null
  keepName                          true | false
  processContext                    "value" | null
  processInstanceHdl                n
  [ createNoObj                     int ]
  xpFmcException                    FMC_OK
End

ProcessTemplate.createInstance
  processTemplateHdl                i
  | processTemplateArrayHdl         i
  instanceName                      "value" | null
  keepName                          true | false
  processInstanceHdl                n
  [ createNoObj                     int ]
  xpFmcException                    FMC_OK
End

ProcessTemplate.creationTime
  processTemplateHdl                i
  | processTemplateArrayHdl         i
  dateTimeHdl                       n
  xpValue                           "dt_value"
End

ProcessTemplate.delete
  processTemplateHdl                i
  | processTemplateArrayHdl         i
  xpFmcException                    FMC_OK
End

ProcessTemplate.delete2
  processTemplateHdl                i
  | processTemplateArrayHdl         i
  pastVersions                      true | false
  currentVersion                    true | false
  futureVersions                    true | false
  xpFmcException                    FMC_OK
End

ProcessTemplate.description
  processTemplateHdl                i
  | processTemplateArrayHdl         i
  xpValue                           "value" | null
End

ProcessTemplate.documentation
  processTemplateHdl                i
  | processTemplateArrayHdl         i
  xpValue                           "value" | null
End

ProcessTemplate.executeProcessInstance     /* version 3.3.0 or > */
  processTemplateHdl                i
  readOnlyContainerHdl              n
  instanceName                      "value" | null
  keepName                          true | false
  processInstanceHdl                n
  xpFmcException                    FMC_OK
End

ProcessTemplate.executeProcessInstance2    /* version 3.3.0 or > */
  processTemplateHdl                i
  readWriteContainerHdl             i | null
  readOnlyContainerHdl              n
  instanceName                      "value" | null
  keepName                          true | false
  processInstanceHdl                n
  xpFmcException                    FMC_OK
End

ProcessTemplate.executeProcessInstance3    /* version 3.3.2 or > */
  processTemplateHdl                i
  readWriteContainerHdl             i | null
  readOnlyContainerHdl              n
  instanceName                      "value" | null
  keepName                          true | false
  processContext                    "value" | null
  processInstanceHdl                n
  xpFmcException                    FMC_OK
End

NOTE: The parameter (object) "readOnlyContainerHolder"
      of ProcessTemplate.executeProcessInstance and executeProcessInstance2
      will be created by the with "new ReadOnlyContainerHolder()" and the
      API result (ReadOnlyContainerHolder.value) will be stored under
      "readOnlyContainerHdl"

ProcessTemplate.icon
  processTemplateHdl                i
  | processTemplateArrayHdl         i
  xpValue                           "value"
End

ProcessTemplate.inContainer                   /* deprecated */
  processTemplateHdl                i
  readWriteContainerHdl             n
  xpFmcException                    FMC_OK
End

ProcessTemplate.inContainerName
  processTemplateHdl                i
  | processTemplateArrayHdl         i
  xpValue                           "value"
End

ProcessTemplate.inContainerNeeded
  processTemplateHdl                i
  | processTemplateArrayHdl         i
  xpValue                           true | false
End

ProcessTemplate.initialInContainer
  processTemplateHdl                i
  readWriteContainerHdl             n
  xpFmcException                    FMC_OK
End

ProcessTemplate.isComplete
  processTemplateHdl                i
  | processTemplateArrayHdl         i
  xpValue                           true | false
End

ProcessTemplate.isEmpty
  processTemplateHdl                i
  | processTemplateArrayHdl         i
  xpValue                           true | false
End

ProcessTemplate.lastModificationTime
  processTemplateHdl                i
  | processTemplateArrayHdl         i
  dateTimeHdl                       n
  xpValue                           "dt_value"
End

ProcessTemplate.name
  processTemplateHdl                i
  | processTemplateArrayHdl         i
  xpValue                           "value"
End

ProcessTemplate.organizationName
  processTemplateHdl                i
  | processTemplateArrayHdl         i
  xpValue                           "value" | null
End

ProcessTemplate.outContainerName
  processTemplateHdl                i
  | processTemplateArrayHdl         i
  xpValue                           "value"
End

ProcessTemplate.persistentOid
  processTemplateHdl                i
  | processTemplateArrayHdl         i
  persistentOidHdl                  n
  [ persistentOidOutputFileSpec     "fileSpec" ]
  xpValue                           "value"
End

ProcessTemplate.persistentOidOfProcessTemplate   /* version 3.3.0 or > */
  processTemplateHdl                i
  | processTemplateArrayHdl         i
  persistentOidHdl                  n
  [ persistentOidOutputFileSpec     "fileSpec" ]
  xpValue                           "value"
End

ProcessTemplate.processAdmin
  processTemplateHdl                i
  | processTemplateArrayHdl         i
  xpValue                           "value" | null
End

ProcessTemplate.programTemplate
  processTemplateHdl                i
  programName                       "value"
  programTemplateHdl                n
  xpFmcException                    FMC_OK
End

ProcessTemplate.refresh
  processTemplateHdl                i
  | processTemplateArrayHdl         i
  xpFmcException                    FMC_OK
End

ProcessTemplate.roleName
  processTemplateHdl                i
  | processTemplateArrayHdl         i
  xpValue                           "value" | null
End

ProcessTemplate.validFromTime
  processTemplateHdl                i
  | processTemplateArrayHdl         i
  dateTimeHdl                       n
  xpValue                           "dt_value"
End