com.bmc.arsys.api
Class EntryListFieldInfo

java.lang.Object
  com.bmc.arsys.api.EntryListFieldInfo

All Implemented Interfaces:

Serializable, Cloneable

public class EntryListFieldInfo
extends Object
implements Cloneable, Serializable

Defines the fields (zero or more) to return with each entry, while retrieving entries from the server.

The EntryListFieldInfo class identifies how the data of all fields (except diary fields and long character fields) should be presented. The system checks the permissions for each specified field and returns only the data of those fields for which the user has access.

See Also:

Serialized Form

Constructor Summary

EntryListFieldInfo()

EntryListFieldInfo(int fldId)

EntryListFieldInfo(int fldId, int ColWidth, String separator)
Constructs a new EntryListFieldInfo 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.
int	getColumnWidth() Returns the column width.
int	getFieldId() Returns the associated FieldId.
String	getSeparator() Returns the characters that are used as separator for the field.
int	hashCode() Returns the hash code value for this instance of the current class.
void	setColumnWidth(int width) Sets the column width.
void	setFieldId(int id) Sets the associated FieldId.
void	setSeparator(String separator) Sets the characters that are used as separator for the field.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EntryListFieldInfo

public EntryListFieldInfo()

EntryListFieldInfo

public EntryListFieldInfo(int fldId,
                          int ColWidth,
                          String separator)
                   throws IllegalArgumentException

Constructs a new EntryListFieldInfo object.

Parameters:

fldId - The FieldId associated with the field.

ColWidth - An integer value indicating the number of characters to display for the field.

separator - The characters to display after the field data. The separator can contain from zero to 10 characters.

Throws:

IllegalArgumentException - if separator's length exceeds 10

EntryListFieldInfo

public EntryListFieldInfo(int fldId)

Method Detail

getFieldId

public int getFieldId()

Returns the associated FieldId.

setFieldId

public void setFieldId(int id)

Sets the associated FieldId.

getColumnWidth

public int getColumnWidth()

Returns the column width.

setColumnWidth

public void setColumnWidth(int width)

Sets the column width.

getSeparator

public String getSeparator()

Returns the characters that are used as separator for the field.

setSeparator

public void setSeparator(String separator)

Sets the characters that are used as separator for the field.

clone

public Object clone()
             throws CloneNotSupportedException

Clone implementation that returns an Object with data cloned from self.

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

equals

public boolean equals(Object obj)

Use this method for checking equality. The result is true only if the argument is not null, is of same type and represents the same content.

Overrides:

equals in class Object

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 Object

toString

public String toString()

Overrides:

toString in class Object