com.bmc.arsys.api
Class COMMethodInfo

java.lang.Object
  com.bmc.arsys.api.COMMethodInfo

All Implemented Interfaces:

Serializable, Cloneable

public class COMMethodInfo
extends Object
implements Cloneable, Serializable

The COMMethodInfo class defines an OLE Automation method.

See Also:

Serialized Form

Constructor Summary

COMMethodInfo()
constructor

COMMethodInfo(String methodName, String methodIId, int methodType, COMValueInfo methodValue, List<COMMethodParmInfo> parameterList)

Method Summary

Object	clone() Clone implementation that returns an Object with data cloned from self
boolean	equals(Object obj) Use this method for checking equality between the current object and the provided one.
String	getMethodIId() Returns ID of the interface that owns the method, length limited by AR_MAX_COM_ID_SIZE (128 bytes)
String	getMethodName() Returns name of the method, length limited by AR_MAX_COM_METHOD_NAME (128 bytes).
int	getMethodType() Returns type of value returned by the method, if any.
COMValueInfo	getMethodValue() Returns AR System field to set to the method's return value, if any.
List<COMMethodParmInfo>	getParameterList() Returns list of the parameters passed to this method.
int	hashCode() Returns the hash code value for this instance of the current class.
void	setMethodIId(String methodIId) Sets ID of the interface that owns the method, length limited by AR_MAX_COM_ID_SIZE (128 bytes)
void	setMethodName(String methodName) Sets name of the method, length limited by AR_MAX_COM_METHOD_NAME (128 bytes).
void	setMethodType(int methodType) Sets type of value returned by the method, if any.
void	setMethodValue(COMValueInfo methodValue) Sets AR System field to set to the method's return value, if any.
void	setParameterList(List<COMMethodParmInfo> parameterList) Returns list of the parameters passed to this method, specified by using the COMMethodParmInfo class.
String	toString() Returns a string description of the object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

COMMethodInfo

public COMMethodInfo()

constructor

COMMethodInfo

public COMMethodInfo(String methodName,
                     String methodIId,
                     int methodType,
                     COMValueInfo methodValue,
                     List<COMMethodParmInfo> parameterList)

Method Detail

getMethodName

public String getMethodName()

Returns name of the method, length limited by AR_MAX_COM_METHOD_NAME (128 bytes).

setMethodName

public void setMethodName(String methodName)

Sets name of the method, length limited by AR_MAX_COM_METHOD_NAME (128 bytes).

getMethodIId

public String getMethodIId()

Returns ID of the interface that owns the method, length limited by AR_MAX_COM_ID_SIZE (128 bytes)

setMethodIId

public void setMethodIId(String methodIId)

Sets ID of the interface that owns the method, length limited by AR_MAX_COM_ID_SIZE (128 bytes)

getMethodType

public int getMethodType()

Returns type of value returned by the method, if any. Possible values are all OLE variant types.

setMethodType

public void setMethodType(int methodType)

Sets type of value returned by the method, if any. Possible values are all OLE variant types.

getMethodValue

public COMValueInfo getMethodValue()

Returns AR System field to set to the method's return value, if any.

setMethodValue

public void setMethodValue(COMValueInfo methodValue)

Sets AR System field to set to the method's return value, if any. This is specified by using the COMValueInfo class.

getParameterList

public List<COMMethodParmInfo> getParameterList()

Returns list of the parameters passed to this method.

setParameterList

public void setParameterList(List<COMMethodParmInfo> parameterList)

Returns list of the parameters passed to this method, specified by using the COMMethodParmInfo class.

clone

public Object clone()
             throws CloneNotSupportedException

Clone implementation that returns an Object with data cloned from self

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

equals

public boolean equals(Object obj)

Use this method for checking equality between the current object and the provided one. The result is true only if the argument is not null, is of the same type and represents the same content.

Overrides:

equals in class Object

Parameters:

obj - the object that we are comparing to

Returns:

returns a boolean that tells if the two objects equal

hashCode

public int hashCode()

Returns the hash code value for this instance of the current class. This method is supported as required by the general contract of Object.hashCode, for the benefit of hash tables such as those provided by java.util.Hashtable.

Overrides:

hashCode in class Object

Returns:

returns the hash code for this instance

toString

public String toString()

Returns a string description of the object.

Overrides:

toString in class Object