com.bmc.arsys.api
Class COMValueInfo

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

All Implemented Interfaces:

Serializable, Cloneable

public class COMValueInfo
extends Object
implements Cloneable, Serializable

The COMValueInfo class is used to define the method and parameter values in the OLE Automation active link action.

See Also:

Serialized Form

Constructor Summary

COMValueInfo()
constructor

COMValueInfo(String valueIId, int transId, int valueType, int fieldId, Value value)

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.
int	getFieldId() Returns union that defines the field ID.
int	getTransId() Returns the Transient ID that links a method that takes another method as a parameter to the method that is used as that parameter.
Value	getValue() Returns union that represents the field value.
String	getValueIId() When used with return value of a method, returns the ID of the interface returned by the method.
int	getValueType() Returns integer specifying the type of value represented by the structure.
int	hashCode() Returns the hash code value for this instance of the current class.
void	setFieldId(int fieldId) Sets union that defines the field ID.
void	setTransId(int transId) Sets the Transient ID that links a method that takes another method as a parameter to the method that is used as that parameter.
void	setValue(Value value) Sets union that represents the field value.
void	setValueIId(String valueIId) When used to define the return value of a method, sets the ID of the interface returned by the method.
void	setValueType(int valueType) Sets integer specifying the type of value represented by the structure.
String	toString() Returns a string description of the object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

COMValueInfo

public COMValueInfo()

constructor

COMValueInfo

public COMValueInfo(String valueIId,
                    int transId,
                    int valueType,
                    int fieldId,
                    Value value)

Method Detail

getFieldId

public int getFieldId()

Returns union that defines the field ID.

setFieldId

public void setFieldId(int fieldId)

Sets union that defines the field ID. For Constants.AR_COM_PARM_FIELDID, this is the ID of the field to set to the return value of this method or the field to pass as this parameter.

getValue

public Value getValue()

Returns union that represents the field value.

setValue

public void setValue(Value value)

Sets union that represents the field value. For Constants.AR_COM_PARM_VALUE, this is the value to pass as this parameter, specified by using the Value class.

getValueIId

public String getValueIId()

• When used with return value of a method, returns the ID of the interface returned by the method.
• When used with the value of a parameter that is an OLE interface, returns the ID of that interface. Otherwise, specify NULL.

setValueIId

public void setValueIId(String valueIId)

• When used to define the return value of a method, sets the ID of the interface returned by the method.
• When used to define the value of a parameter that is an OLE interface, sets the ID of that interface. Otherwise, specify NULL.

getTransId

public int getTransId()

Returns the Transient ID that links a method that takes another method as a parameter to the method that is used as that parameter.

setTransId

public void setTransId(int transId)

Sets the Transient ID that links a method that takes another method as a parameter to the method that is used as that parameter. For example, Method A takes Method B as a parameter. Use the same integer value here for the Value class that defines the return value for Method B as you do for the class that defines the parameter value of Method A.

getValueType

public int getValueType()

Returns integer specifying the type of value represented by the structure.

setValueType

public void setValueType(int valueType)

Sets integer specifying the type of value represented by the structure. For AR_COM_METHOD_NULL, set the other members of the structure to NULL or 0.

Parameters:

valueType - Possible values include the following:

• Constants.AR_COM_METHOD_NULL Method return value
• Constants.AR_COM_METHOD_FIELDID Method return value
• Constants.AR_COM_PARM_NULL Parameter return value
• Constants.AR_COM_PARM_FIELDID Parameter return value
• Constants.AR_COM_PARM_VALUE Parameter return value

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