com.bmc.arsys.api

Class ColumnFieldLimit

java.lang.Object

com.bmc.arsys.api.FieldLimit

com.bmc.arsys.api.ColumnFieldLimit

All Implemented Interfaces:

Serializable, Cloneable

public class ColumnFieldLimit
extends FieldLimit
implements Cloneable, Serializable

The ColumnFieldLimit class represents the value limits for a column(DataType.COLUMN) field.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ColumnFieldLimit() Constructs a new ColumnLimitInfo object.
ColumnFieldLimit(int parent, int data, int dataSource, int length) Constructs a new ColumnLimitInfo object.

Method Summary

Modifier and Type	Method and Description
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	getColumnLength() Returns the maximum column length to display.
int	getDataField() Returns the FieldID of the data field.
int	getDataSource() Returns the data source.
int	getParent() Returns the FieldID of the parent field the column belongs to.
int	hashCode() Returns the hash code value for this instance of the current class.
void	setColumnLength(int length) Sets the maximum column length to display.
void	setDataField(int data) Sets the FieldID of the data field.
void	setDataSource(int dataSource) Sets the data source.
void	setParent(int parent) Sets the FieldID of the parent field the column belongs to.
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

ColumnFieldLimit

public ColumnFieldLimit()

Constructs a new ColumnLimitInfo object.

ColumnFieldLimit

public ColumnFieldLimit(int parent,
                        int data,
                        int dataSource,
                        int length)

Constructs a new ColumnLimitInfo object.

Parameters:

parent - Field ID of parent field the column belongs to.

data - Field ID of data field.

dataSource - Data source for the field

length - Column length to display.

Method Detail

getParent

public int getParent()

Returns the FieldID of the parent field the column belongs to.

getDataField

public int getDataField()

Returns the FieldID of the data field.

getDataSource

public int getDataSource()

Returns the data source. You can return the following constant values:

• Constants.AR_COLUMN_LIMIT_DATASOURCE_DATA_FIELD -- 0, from regular dataField.
• Constants.AR_COLUMN_LIMIT_DATASOURCE_DISPLAY_FIELD -- 1, from display-only dataField.
• Constants.AR_COLUMN_LIMIT_DATASOURCE_CONTROL_FIELD -- 2, from local control field.
• Constants.AR_COLUMN_LIMIT_DATASOURCE_TRIM_FIELD -- 3, from local trim field.
• Constants.AR_COLUMN_LIMIT_DATASOURCE_VIEW_FIELD -- 4, from local view field.

getColumnLength

public int getColumnLength()

Returns the maximum column length to display.

setParent

public void setParent(int parent)

Sets the FieldID of the parent field the column belongs to.

setDataField

public void setDataField(int data)

Sets the FieldID of the data field.

setDataSource

public void setDataSource(int dataSource)

Sets the data source.

setColumnLength

public void setColumnLength(int length)

Sets the maximum column length to display.

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