WebSphere MQ Workflow 3.4.0 Java Generic API Test / Prototyping Tool

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

Agent

===SYNTAX FOR AGENT APIs================================================

Agent.Agent
  agentHdl                          n
End

Agent.getConfigurationID
  agentHdl                          i
  xpValue                           "value" | "<CL-VALUE>"
End

Agent.getExecutionAgent
  agentHdl                          i
  executionAgentHdl                 n
  xpFmcException                    FMC_OK
End

Agent.getLocator
  agentHdl                          i
  xpValue                           LOC_LOCATOR
                                  | JNDI_LOCATOR
                                  | <CL-VALUE>
End

Agent.getName
  agentHdl                          i
  xpValue                           "value" | "<CL-VALUE>"
End

Agent.isBound
  agentHdl                          i
  xpValue                           true | false
End

Agent.locate
  agentHdl                          i
  systemGroup                       "value" | "<CL-VALUE>"
  system                            "value" | "<CL-VALUE>"
  executionServiceHdl               n
  xpFmcException                    FMC_OK
End

Agent.locateViaPropertyFile                /* tool macro */
  agentHdl                          i
  executionServiceHdl               n
  xpFmcException                    FMC_OK
End

Agent.setConfigurationID
  agentHdl                          i
  configurationID                   "value" | "<CL-VALUE>"
  xpFmcException                    FMC_OK
End

Agent.setContext
  agentHdl                          i
  args                              null
  properties                        SystemProperties
End

REMARK: For SystemProperties see/use also
        Tool.getProperties, Tool.putProperty and Tool.listProperties

Agent.setLocator
  agentHdl                          i
  locator                           LOC_LOCATOR
                                  | JNDI_LOCATOR
                                  | <CL-VALUE>
End

/* NOTE: The
         COS_LOCATOR,
         IOR_LOCATOR,
         OSA_LOCATOR,
         RMI_LOCATOR
         have been removed in MQ Workflow version 3.4.0 */

Agent.setName
  agentHdl                          i
  name                              "value" | "<CL-VALUE>"
End

Agent.versionInfo
  agentHdl                          i
End