IBM Rational Performance Tester SDK

com.ibm.rational.test.lt.trace
Class UDMethodDefMsg

java.lang.Object
  extended by com.ibm.rational.test.lt.trace.Msg
      extended by com.ibm.rational.test.lt.trace.UDMethodBaseMsg
          extended by com.ibm.rational.test.lt.trace.UDMethodDefMsg
All Implemented Interfaces:
Serializable

public class UDMethodDefMsg
extends UDMethodBaseMsg

See Also:
Serialized Form

Constructor Summary
UDMethodDefMsg()
          Class constructor.
UDMethodDefMsg(String protocol, String vendor, String version, int id, int cdid)
          Class constructor specifying various properties.
UDMethodDefMsg(String protocol, String vendor, String version, int id, int cdid, String name)
          Class constructor specifying various properties.
 
Method Summary
 int addparameterDef(String name, String type)
          Add a parameter definition to the methodDef
 int getClassDefID()
          Gets the classDef ID associated with this msg.
 int getID()
          Gets the methodDef ID associated with this msg.
 String getName()
          Gets the name of the method associated with this msg.
 String[] getParameterNames()
          Gets an array of parameter names for this msg.
 String[] getParameterTypes()
          Gets an array of parameter types for this msg.
 String getReturnValueType()
          Gets the return value type for this msg.
 void setClassDefID(int cdid)
          Sets the classDef ID associated with this msg.
 void setID(int id)
          Sets the methodDef ID associated with this msg.
 void setName(String name)
          Sets the name of the method associated with this msg.
 void setReturnValueType(String type)
          Sets the return value type for this msg.
 
Methods inherited from class com.ibm.rational.test.lt.trace.UDMethodBaseMsg
getMethodDefID, getParameterBytes, getParameterString, setMethodDefID, setParameterBytes, setParameterString
 
Methods inherited from class com.ibm.rational.test.lt.trace.Msg
getProtocol, getTicket, getTimestamp, getVendor, getVersion, setProtocol, setTicket, setTimestamp, setVendor, setVersion
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

UDMethodDefMsg

public UDMethodDefMsg()
Class constructor.


UDMethodDefMsg

public UDMethodDefMsg(String protocol,
                      String vendor,
                      String version,
                      int id,
                      int cdid)
Class constructor specifying various properties.

Parameters:
protocol - protocol name (example: "HTTP")
vendor - vendor name (example: "IBM")
version - version string (example: "6.1.2.0")
id - the methodDef ID associated with this User Defined msg (example: 1, 2, 3, etc.)
cdid - the classDef ID associated with this User Defined msg (example: 1, 2, 3, etc.)

UDMethodDefMsg

public UDMethodDefMsg(String protocol,
                      String vendor,
                      String version,
                      int id,
                      int cdid,
                      String name)
Class constructor specifying various properties.

Parameters:
protocol - protocol name (example: "HTTP")
vendor - vendor name (example: "IBM")
version - version string (example: "6.1.2.0")
id - the methodDef ID associated with this User Defined msg (example: 1, 2, 3, etc.)
cdid - the classDef ID associated with this User Defined msg (example: 1, 2, 3, etc.)
name - name of this method (example: "method1")
Method Detail

getID

public int getID()
Gets the methodDef ID associated with this msg.

Returns:
integer reflecting the methodDef ID associated with this msg

setID

public void setID(int id)
Sets the methodDef ID associated with this msg. This value will be subsequently used to associate UDMethodEntry|Exit|InvocationMsg objects with this methodDef. The actual value used here is arbitrary, but generally, a recorder should start these values at 1, and increment by 1 for each methodDef defined.

Parameters:
id - integer reflecting the methodDef ID associated with this msg

getClassDefID

public int getClassDefID()
Gets the classDef ID associated with this msg.

Returns:
integer reflecting the classDef ID associated with this msg

setClassDefID

public void setClassDefID(int cdid)
Sets the classDef ID associated with this msg. This value will be subsequently used to associate UDMethodDefMsg objects with this classDef. The actual value used here is arbitrary, but generally, a recorder should start these values at 1, and increment by 1 for each classDef defined.

Parameters:
cdid - integer reflecting the classDef ID associated with this msg

getName

public String getName()
Gets the name of the method associated with this msg.

Returns:
string containing the method name associated with this msg

setName

public void setName(String name)
Sets the name of the method associated with this msg.

Parameters:
name - string containing the method name associated with this msg

addparameterDef

public int addparameterDef(String name,
                           String type)
                    throws TraceException
Add a parameter definition to the methodDef

Parameters:
name - the name of the parameter
type - the type of the parameter (and 'type' must be either 'STRING' or 'BYTES').
Returns:
the parameter position on the method
Throws:
TraceException - if name or type is null or type is not "STRING" or "BYTES"

getParameterNames

public String[] getParameterNames()
Gets an array of parameter names for this msg.

Returns:
array of parameter names for this msg

getParameterTypes

public String[] getParameterTypes()
Gets an array of parameter types for this msg.

Returns:
array of parameter types for this msg

getReturnValueType

public String getReturnValueType()
Gets the return value type for this msg.

Returns:
return value type for this msg

setReturnValueType

public void setReturnValueType(String type)
                        throws TraceException
Sets the return value type for this msg.

Parameters:
type - the return value type for this msg
Throws:
TraceException - if return value type is null or type is not "STRING" or "BYTES"

IBM Rational Performance Tester SDK

© Copyright IBM Corp. 2012. All rights reserved.