au.com.swz.jatlom
Class ParamDesc

java.lang.Object
  extended by au.com.swz.jatlom.ParamDesc

public class ParamDesc
extends java.lang.Object

Contains the details of a parameter, or function return value.

Author:
Mark Richter

Constructor Summary
ParamDesc()
           
 
Method Summary
 boolean equals(java.lang.Object obj)
          Checks this parameter with equality to the specified object.
 boolean equals(ParamDesc paramDesc)
          Checks this parameter with equality to the specified parameter.
 Variant getDefaultValue()
          Returns the default value of this parameter.
 java.lang.Integer getMemberId()
          Returns the Member/Disp Id of this parameter.
 java.lang.String getName()
          Returns the name of this parameter.
 TypeDesc getTypeDesc()
          Provides the parameter type.
 boolean hasCustomData()
          Determines if this parameter has custom data.
 boolean hasDefaultValue()
          Returns true if this parameter has a default value defined.
 boolean isInDirection()
          This method returns true if this parameter passes information from the caller to the callee.
 boolean isLcid()
          Determines if this parameter is the LCID of a client application.
 boolean isOptional()
          Returns true if this is an optional parameter.
 boolean isOutDirection()
          This method returns true if this parameter returns information from the callee to the caller.
 boolean isReturnValue()
          Returns true if this parameter is the return value of the member.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ParamDesc

public ParamDesc()
Method Detail

getDefaultValue

public Variant getDefaultValue()
Returns the default value of this parameter. This method returns null if this parameter does not have a default value defined.

Returns:
the default value of this parameter.

isInDirection

public boolean isInDirection()
This method returns true if this parameter passes information from the caller to the callee.

Returns:
true if this parameter is an 'IN' parameter.

isOutDirection

public boolean isOutDirection()
This method returns true if this parameter returns information from the callee to the caller.

Returns:
true if this parameter is an 'OUT' parameter.

hasDefaultValue

public boolean hasDefaultValue()
Returns true if this parameter has a default value defined.

Returns:
true if this parameter has a default value defined.

isReturnValue

public boolean isReturnValue()
Returns true if this parameter is the return value of the member.

Returns:
true if this parameter is the return value of the member.

isOptional

public boolean isOptional()
Returns true if this is an optional parameter. The parameter may or may not have a default value defined.

Returns:
true if this is an optional parameter.

hasCustomData

public boolean hasCustomData()
Determines if this parameter has custom data.

Returns:
true if this parameter has custom data.

isLcid

public boolean isLcid()
Determines if this parameter is the LCID of a client application.

Returns:
true if this parameter is the LCID of a client application.

getName

public java.lang.String getName()
Returns the name of this parameter.

Returns:
a String that contains the name of this parameter.

getTypeDesc

public TypeDesc getTypeDesc()
Provides the parameter type.

Returns:
the parameter type.

getMemberId

public java.lang.Integer getMemberId()
Returns the Member/Disp Id of this parameter. This value can be null if this parameter does not have a member Id. This value is used to pass named arguments in calling functions that contain optional paramters.

Returns:
the Member/Disp Id of this parameter.

equals

public boolean equals(java.lang.Object obj)
Checks this parameter with equality to the specified object. If the object is not of type ParamDesc then this method returns false.

Overrides:
equals in class java.lang.Object
Returns:
true if this object equals the specified object.

equals

public boolean equals(ParamDesc paramDesc)
Checks this parameter with equality to the specified parameter. If all fields in the specified parameter are identical to this one then this method returns true otherwise it returns false.

Returns:
true if all fields in the specified parameter are identical to this one.