WebSphere MQ Workflow 3.4.0 Java Generic API Test / Prototyping Tool

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

ExecutionService

===SYNTAX FOR EXECUTION SERVICE APIs====================================

ExecutionService.createProcessInstanceList
  executionServiceHdl               i
  listName                          "value"
  persistentListType                NOT_SET
                                  | PUBLIC
                                  | PRIVATE
                                  | (any integer)
  owner                             "value" | null
  description                       "value" | null
  filter                            "fi_value" | null
  sortCriteria                      "sc_value" | null
  threshold                         int | null
  processInstanceListHdl            n
  xpFmcException                    FMC_OK
End

ExecutionService.createProcessTemplateList
  executionServiceHdl               i
  listName                          "value"
  persistentListType                NOT_SET
                                  | PUBLIC
                                  | PRIVATE
                                  | (any integer)
  owner                             "value" | null
  description                       "value" | null
  filter                            "fi_value" | null
  sortCriteria                      "sc_value" | null
  threshold                         int | null
  processTemplateListHdl            n
  xpFmcException                    FMC_OK
End

ExecutionService.createWorkList
  executionServiceHdl               i
  listName                          "value"
  persistentListType                NOT_SET
                                  | PUBLIC
                                  | PRIVATE
                                  | (any integer)
  owner                             "value" | null
  description                       "value" | null
  filter                            "fi_value" | null
  sortCriteria                      "sc_value" | null
  threshold                         int | null
  workListHdl                       n
  xpFmcException                    FMC_OK
End

ExecutionService.forceLogoff        /* version 3.4.0 or > */
  executionServiceHdl               i
  userID                            "value" | "<CL-VALUE>"
  xpFmcException                    FMC_OK
End

ExecutionService.forceProgramExecutionAgentShutDown   /* version 3.4.0 or > */
  executionServiceHdl               i
  userID                            "value" | "<CL-VALUE>"
  xpFmcException                    FMC_OK
End

ExecutionService.logoff
  executionServiceHdl               i
  xpFmcException                    FMC_OK
End

ExecutionService.logon
  executionServiceHdl               i
  userID                            "value" | "<CL-VALUE>"
  password                          "value" | "<CL-VALUE>"
  xpFmcException                    FMC_OK
End

ExecutionService.logon2
  executionServiceHdl               i
  userID                            "value" | "<CL-VALUE>"
  password                          "value" | "<CL-VALUE>"
  sessionMode                       DEFAULT
                                  | PRESENT
                                  | PRESENT_HERE
                                  | (any integer)
  absenceIndicator                  NOT_SET
                                  | RESET
                                  | LEAVE
                                  | (any integer)
  xpFmcException                    FMC_OK
End

ExecutionService.logon3                          /* version 3.3.0 or > */
  executionServiceHdl                i
  userCredentialsAsString            "value"
  | userCredentialsAsByteInHex       "hex_value"
  | userCredentialsByteInputFileSpec "fileSpec"
  xpFmcException                     FMC_OK
End

ExecutionService.logon4                          /* version 3.3.0 or > */
  executionServiceHdl                i
  userCredentialsAsString            "value"
  | userCredentialsAsByteInHex       "hex_value"
  | userCredentialsByteInputFileSpec "fileSpec"
  sessionMode                        DEFAULT
                                   | PRESENT
                                   | PRESENT_HERE
                                   | (any integer)
  absenceIndicator                   NOT_SET
                                   | RESET
                                   | LEAVE
                                   | (any integer)
  userName                           "value"
  xpFmcException                     FMC_OK
End

ExecutionService.passthrough
  executionServiceHdl               i
  xpFmcException                    FMC_OK
End

ExecutionService.persistentActivityInstance      /* version 3.2.2 or > */
  executionServiceHdl               i
  persistentOidHdl                  i
  | persistentOidInputFileSpec      "fileSpec"
  activityInstanceHdl               n
End

ExecutionService.persistentActivityInstanceNotification
  executionServiceHdl               i
  persistentOidHdl                  i
  | persistentOidInputFileSpec      "fileSpec"
  activityInstanceNotificationHdl   n
End

ExecutionService.persistentInstanceMonitor       /* version 3.3.0 or > */
  executionServiceHdl               i
  persistentOidHdl                  i
  | persistentOidInputFileSpec      "fileSpec"
  instanceMonitorHdl                n
End

ExecutionService.persistentPerson                /* version 3.3.0 or > */
  executionServiceHdl               i
  userID                            "value" | "<CL-VALUE>"
  personHdl                         n
End

ExecutionService.persistentProcessInstance
  executionServiceHdl               i
  persistentOidHdl                  i
  | persistentOidInputFileSpec      "fileSpec"
  processInstanceHdl                n
End

ExecutionService.persistentProcessInstanceList   /* version 3.3.0 or > */
  executionServiceHdl               i
  persistentOidHdl                  i
  | persistentOidInputFileSpec      "fileSpec"
  processInstanceListHdl            n
End

ExecutionService.persistentProcessInstanceNotification
  executionServiceHdl               i
  persistentOidHdl                  i
  | persistentOidInputFileSpec      "fileSpec"
  processInstanceNotificationHdl    n
End

ExecutionService.persistentProcessTemplate
  executionServiceHdl               i
  persistentOidHdl                  i
  | persistentOidInputFileSpec      "fileSpec"
  processTemplateHdl                n
End

ExecutionService.persistentProcessTemplateList   /* version 3.3.0 or > */
  executionServiceHdl               i
  persistentOidHdl                  i
  | persistentOidInputFileSpec      "fileSpec"
  processTemplateListHdl            n
End

ExecutionService.persistentWorkItem
  executionServiceHdl               i
  persistentOidHdl                  i
  | persistentOidInputFileSpec      "fileSpec"
  workItemHdl                       n
End

ExecutionService.persistentWorkList              /* version 3.3.0 or > */
  executionServiceHdl               i
  persistentOidHdl                  i
  | persistentOidInputFileSpec      "fileSpec"
  workListHdl                       n
End

ExecutionService.programDataFromStream           /* version 3.3.0 or > */
  executionServiceHdl               i
  streamHdl                         i
  | streamInputFileSpec             "fileSpec"
  programDataHdl                    n
End

ExecutionService.programExecutionAgentShutDown
  executionServiceHdl               i
  xpFmcException                    FMC_OK
End

ExecutionService.programExecutionAgentStartUp
  executionServiceHdl               i
  xpFmcException                    FMC_OK
End

ExecutionService.programTemplateFromStream       /* version 3.3.0 or > */
  executionServiceHdl               i
  streamHdl                         i
  | streamInputFileSpec             "fileSpec"
  programTemplateHdl                n
End

ExecutionService.queryActivityInstanceNotifications
  executionServiceHdl               i
  filter                            "fi_value" | null
  sortCriteria                      "sc_value" | null
  threshold                         int | null
  activityInstanceNotificationArrayHdl  n
  [ showAllObjectNames              true | false ]
  xpFmcException                    FMC_OK
End

ExecutionService.queryItems
  executionServiceHdl               i
  filter                            "fi_value" | null
  sortCriteria                      "sc_value" | null
  threshold                         int | null
  itemArrayHdl                      n
  [ showAllObjectNames              true | false ]
  xpFmcException                    FMC_OK
End

ExecutionService.queryProcessInstanceLists
  executionServiceHdl               i
  processInstanceListArrayHdl       n
  [ showAllObjectNames              true | false ]
  xpFmcException                    FMC_OK
End

ExecutionService.queryProcessInstanceNotifications
  executionServiceHdl               i
  filter                            "fi_value" | null
  sortCriteria                      "sc_value" | null
  threshold                         int | null
  processInstanceNotificationArrayHdl n
  [ showAllObjectNames              true | false ]
  xpFmcException                    FMC_OK
End

ExecutionService.queryProcessInstances
  executionServiceHdl               i
  filter                            "fi_value" | null
  sortCriteria                      "sc_value" | null
  threshold                         int | null
  processInstanceArrayHdl           n
  [ showAllObjectNames              true | false ]
  xpFmcException                    FMC_OK
End

ExecutionService.queryProcessTemplateLists
  executionServiceHdl               i
  processTemplateListArrayHdl       n
  [ showAllObjectNames              true | false ]
  xpFmcException                    FMC_OK
End

ExecutionService.queryProcessTemplates
  executionServiceHdl               i
  filter                            "fi_value" | null
  sortCriteria                      "sc_value" | null
  threshold                         int | null
  processTemplateArrayHdl           n
  [ showAllObjectNames              true | false ]
  xpFmcException                    FMC_OK
End

ExecutionService.queryWorkItems
  executionServiceHdl               i
  filter                            "fi_value" | null
  sortCriteria                      "sc_value" | null
  threshold                         int | null
  workItemArrayHdl                  n
  [ showAllObjectNames              true | false ]
  xpFmcException                    FMC_OK
End

ExecutionService.queryWorkLists
  executionServiceHdl               i
  workListArrayHdl                  n
  [ showAllObjectNames              true | false ]
  xpFmcException                    FMC_OK
End

ExecutionService.readOnlyContainerFromStream     /* version 3.3.0 or > */
  executionServiceHdl               i
  streamHdl                         i
  | streamInputFileSpec             "fileSpec"
  readOnlyContainerHdl              n
End

ExecutionService.readWriteContainerFromStream    /* version 3.3.0 or > */
  executionServiceHdl               i
  streamHdl                         i
  | streamInputFileSpec             "fileSpec"
  readWriteContainerHdl             n
End

ExecutionService.remotePassthrough
  executionServiceHdl               i
  programID                         DEFAULT
                                  | "value"
  | programIdInputFileSpec          "fileSpec"
  xpFmcException                    FMC_OK
End

ExecutionService.sessionID                       /* version 3.3.0 or > */
  executionServiceHdl               i
  sessionIdHdl                      n
  [ sessionIdOutputFileSpec         "fileSpec" ]
  xpValue                           "value"
End

ExecutionService.setPersonAbsent                 /* version 3.2.1 SP1 or > */
  executionServiceHdl               i
  xpFmcException                    FMC_OK
End

ExecutionService.setPersonAbsent2                /* version 3.2.1 SP1 or > */
  executionServiceHdl               i
  userID                            "value"
  absence                           true | false
  xpFmcException                    FMC_OK
End

ExecutionService.setSessionContext               /* version 3.3.0 or > */
  executionServiceHdl               i
  userID                            "value" | "<CL-VALUE>"
  sessionId                         "value" | "<CL-VALUE>"
  | sessionIdInputFileSpec          "fileSpec"
  | sessionIdHdl                    i
  xpFmcException                    FMC_OK
End

---Methods inherited from interface com.ibm.workflow.api.Service--------

ExecutionService.isLoggedOn
  executionServiceHdl               i
  xpValue                           true | false
End

ExecutionService.reconnectCount                  /* version 3.3.2 or > */
  executionServiceHdl               i
  xpValue                           int
End

ExecutionService.refresh
  executionServiceHdl               i
  xpFmcException                    FMC_OK
End

ExecutionService.setPassword
  executionServiceHdl               i
  password                          "value"
  xpFmcException                    FMC_OK
End

ExecutionService.setReconnectCount               /* version 3.3.2 or > */
  executionServiceHdl               i
  count                             int
End

ExecutionService.setTimeout
  executionServiceHdl               i
  timeout                           int
End

ExecutionService.systemName
  executionServiceHdl               i
  xpValue                           "value" | "<CL-VALUE>" | null
End

ExecutionService.systemGroupName
  executionServiceHdl               i
  xpValue                           "value" | "<CL-VALUE>" | null
End

ExecutionService.timeout
  executionServiceHdl               i
  xpValue                           int
End

ExecutionService.userID
  executionServiceHdl               i
  xpValue                           "value" | "<CL-VALUE>"
End

ExecutionService.userSettings
  executionServiceHdl               i
  personHdl                         n
  xpFmcException                    FMC_OK
End