com.bmc.arsys.api
Class DisplayFieldLimit

java.lang.Object
  com.bmc.arsys.api.FieldLimit
      com.bmc.arsys.api.DisplayFieldLimit

All Implemented Interfaces:

Serializable, Cloneable

public class DisplayFieldLimit
extends FieldLimit
implements Cloneable, Serializable

The DisplayFieldLimit class defines the value limits for a display(DataType.DISPLAY) field.

See Also:

Serialized Form

Constructor Summary

DisplayFieldLimit()

DisplayFieldLimit(int max)
Constructs a new DisplayFieldLimit object using the given maximum length.

DisplayFieldLimit(int max, int lengthUnits)
Constructs a new DisplayFieldLimit object using the given maximum length and length unit.

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	getLengthUnits() Returns the length unit, one of Constants.AR_LENGTH_UNIT_BYTE -- count in bytes Constants.AR_LENGTH_UNIT_CHAR -- count in server characters
int	getMaxLength() Returns the maximum field length
int	hashCode() Returns the hash code value for this instance of the current class.
void	setLengthUnits(int lengthUnits) Sets the length unit, one of Constants.AR_LENGTH_UNIT_BYTE -- count in bytes Constants.AR_LENGTH_UNIT_CHAR -- count in server characters
void	setMaxLength(int max) Sets the maximum field length.
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

DisplayFieldLimit

public DisplayFieldLimit(int max)

Constructs a new DisplayFieldLimit object using the given maximum length.

Parameters:

max - Maximum field length. Specify zero to indicate no maximum.

DisplayFieldLimit

public DisplayFieldLimit(int max,
                         int lengthUnits)

Constructs a new DisplayFieldLimit object using the given maximum length and length unit.

Parameters:

max - Maximum field length. Specify zero to indicate no maximum.

lengthUnits - Server's field length unit, one of

• Constants.AR_LENGTH_UNIT_BYTE -- count in bytes
• Constants.AR_LENGTH_UNIT_CHAR -- count in server characters

DisplayFieldLimit

public DisplayFieldLimit()

Method Detail

setMaxLength

public void setMaxLength(int max)

Sets the maximum field length.

setLengthUnits

public void setLengthUnits(int lengthUnits)

Sets the length unit, one of

• Constants.AR_LENGTH_UNIT_BYTE -- count in bytes
• Constants.AR_LENGTH_UNIT_CHAR -- count in server characters

getMaxLength

public int getMaxLength()

Returns the maximum field length

getLengthUnits

public int getLengthUnits()

Returns the length unit, one of

• Constants.AR_LENGTH_UNIT_BYTE -- count in bytes
• Constants.AR_LENGTH_UNIT_CHAR -- count in server characters

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