com.bmc.arsys.api
Class TableFieldLimit

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

All Implemented Interfaces:

Serializable, Cloneable

public class TableFieldLimit
extends FieldLimit
implements Cloneable, Serializable

The TableFieldLimit class defines the value limits for a table(DataType.TABLE) field.

See Also:

Serialized Form

Constructor Summary

TableFieldLimit()

TableFieldLimit(int colCount, QualifierInfo qualification, int max, String form, String server, String sampleForm, String sampleServer)
Constructs a new TableLimitInfo object.

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	getColumnCount() Returns the number of columns.
String	getForm() Returns the name of form to which the data fields belong.
int	getMaxRetrieve() Returns the maximum number of rows retrieved.
QualifierInfo	getQualifier() Returns the search qualification.
String	getSampleForm() Returns the name of the sample form.
String	getSampleServer() Returns the name of the sample server.
String	getServer() Returns the name of server on which the form resides.
int	hashCode() Returns the hash code value for this instance of the current class.
void	setColumnCount(int colCount) Sets the number of columns.
void	setForm(String form) Sets the name of form to which the data fields belong.
void	setMaxRetrieve(int max) Sets the maximum number of rows retrieved.
void	setQualifier(QualifierInfo qualification) Sets the search qualification.
void	setSampleForm(String sampleForm) Sets the name of the sample form.
void	setSampleServer(String sampleServer) Sets the name of the sample server.
void	setServer(String server) Sets the name of server on which the form resides.
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

TableFieldLimit

public TableFieldLimit()

TableFieldLimit

public TableFieldLimit(int colCount,
                       QualifierInfo qualification,
                       int max,
                       String form,
                       String server,
                       String sampleForm,
                       String sampleServer)

Constructs a new TableLimitInfo object.

Parameters:

colCount - Number of columns.

qualification - Search qualification.

max - Maximum number of rows to retrieve.

form - Name of form to which data fields belong.

server - Name of server on which the specified form resides.

Method Detail

setColumnCount

public void setColumnCount(int colCount)

Sets the number of columns.

setQualifier

public void setQualifier(QualifierInfo qualification)

Sets the search qualification.

setMaxRetrieve

public void setMaxRetrieve(int max)

Sets the maximum number of rows retrieved.

setForm

public void setForm(String form)

Sets the name of form to which the data fields belong.

setServer

public void setServer(String server)

Sets the name of server on which the form resides.

setSampleForm

public void setSampleForm(String sampleForm)

Sets the name of the sample form. This is used by the authoring environment when the form is a reference to a value rather than an actual form name.

setSampleServer

public void setSampleServer(String sampleServer)

Sets the name of the sample server. This is used by the authoring environment when the server is a reference to a value rather than an actual server name.

getColumnCount

public int getColumnCount()

Returns the number of columns.

getQualifier

public QualifierInfo getQualifier()

Returns the search qualification.

getMaxRetrieve

public int getMaxRetrieve()

Returns the maximum number of rows retrieved.

getForm

public String getForm()

Returns the name of form to which the data fields belong.

getServer

public String getServer()

Returns the name of server on which the form resides.

getSampleForm

public String getSampleForm()

Returns the name of the sample form. This is used by the authoring environment when the form is a reference to a value rather than an actual form name.

getSampleServer

public String getSampleServer()

Returns the name of the sample server. This is used by the authoring environment when the server is a reference to a value rather than an actual server name.

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