AR System Java API

com.bmc.arsys.api
Class CurrencyFieldLimit

java.lang.Object
  extended by com.bmc.arsys.api.FieldLimit
      extended by com.bmc.arsys.api.CurrencyFieldLimit
All Implemented Interfaces:
Serializable, Cloneable

public class CurrencyFieldLimit
extends FieldLimit
implements Cloneable, Serializable

The CurrencyFieldLimit class defines the value limits for a Currency (DataType.CURRENCY) field

See Also:
Serialized Form

Constructor Summary
CurrencyFieldLimit()
          Constructs an empty CurrencyLimitInfo object.
CurrencyFieldLimit(BigDecimal lowLimit, BigDecimal highLimit, int precision)
          Constructs a CurrencyLimitInfo object using the limit and precision info
CurrencyFieldLimit(BigDecimal lowLimit, BigDecimal highLimit, int precision, List<CurrencyDetail> functional, List<CurrencyDetail> allowable)
           
CurrencyFieldLimit(String lowLimit, String highLimit, int precision)
          Constructs a CurrencyLimitInfo object using the limit and precision info
CurrencyFieldLimit(String lowLimit, String highLimit, int precision, List<CurrencyDetail> functional, List<CurrencyDetail> allowable)
           
 
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.
 List<CurrencyDetail> getAllowable()
          Retrieves currency types that the server will allow user to enter
 List<CurrencyDetail> getFunctional()
          Retrieves currency types that are always stored in the database
 BigDecimal getHighRange()
          Retrieves the upper-range limit.
 BigDecimal getLowRange()
          Retrieves the lower-range limit.
 int getPrecision()
          Retrieves the display precision (the number of places to the right of the decimal point ).
 int hashCode()
          Returns the hash code value for this instance of the current class.
 void setHighRange(BigDecimal highLimit)
          Sets the upper-range limit.
 void setLowRange(BigDecimal lowLimit)
          Sets the lower-range limit.
 void setPrecision(int precision)
          Sets the display precision.
 String toString()
          Returns a string description of the object.
 
Methods inherited from class com.bmc.arsys.api.FieldLimit
getDataType
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CurrencyFieldLimit

public CurrencyFieldLimit()
Constructs an empty CurrencyLimitInfo object.


CurrencyFieldLimit

public CurrencyFieldLimit(String lowLimit,
                          String highLimit,
                          int precision)
Constructs a CurrencyLimitInfo object using the limit and precision info

Parameters:
lowLimit - Lower-range limit.
highLimit - Upper-range limit.
precision - Display precision.

CurrencyFieldLimit

public CurrencyFieldLimit(BigDecimal lowLimit,
                          BigDecimal highLimit,
                          int precision)
Constructs a CurrencyLimitInfo object using the limit and precision info

Parameters:
lowLimit - Lower-range limit.
highLimit - Upper-range limit.
precision - Display precision.

CurrencyFieldLimit

public CurrencyFieldLimit(String lowLimit,
                          String highLimit,
                          int precision,
                          List<CurrencyDetail> functional,
                          List<CurrencyDetail> allowable)

CurrencyFieldLimit

public CurrencyFieldLimit(BigDecimal lowLimit,
                          BigDecimal highLimit,
                          int precision,
                          List<CurrencyDetail> functional,
                          List<CurrencyDetail> allowable)
Method Detail

setLowRange

public void setLowRange(BigDecimal lowLimit)
Sets the lower-range limit.


setHighRange

public void setHighRange(BigDecimal highLimit)
Sets the upper-range limit.


setPrecision

public void setPrecision(int precision)
Sets the display precision.


getLowRange

public BigDecimal getLowRange()
Retrieves the lower-range limit.


getHighRange

public BigDecimal getHighRange()
Retrieves the upper-range limit.


getPrecision

public int getPrecision()
Retrieves the display precision (the number of places to the right of the decimal point ).


getAllowable

public List<CurrencyDetail> getAllowable()
Retrieves currency types that the server will allow user to enter


getFunctional

public List<CurrencyDetail> getFunctional()
Retrieves currency types that are always stored in the database


clone

public Object clone()
             throws CloneNotSupportedException
Clone implementation that returns an Object with data cloned from self.

Overrides:
clone in class FieldLimit
Throws:
CloneNotSupportedException

toString

public String toString()
Returns a string description of the object.

Overrides:
toString in class FieldLimit

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 FieldLimit
Returns:
returns the hash code for this instance

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 FieldLimit
Parameters:
obj - the object that we are comparing to
Returns:
returns a boolean that tells if the two objects equal

AR System Java API

© Copyright 2006, 2007 BMC Software, Inc.