com.remedy.arsys.api
Class EntryListFieldInfo

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

All Implemented Interfaces:

java.lang.Cloneable

public class EntryListFieldInfo

extends java.lang.Object

implements java.lang.Cloneable

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.

Constructor Summary

EntryListFieldInfo(FieldID fldID)

EntryListFieldInfo(FieldID fldID, int ColWidth, java.lang.String separator)
Constructs a new EntryListFieldInfo object.

Method Summary

java.lang.Object	clone() Clone implementation that returns an Object with data cloned from self.
boolean	equals(java.lang.Object anObject) Use this method for checking equality.
int	getColumnWidth() Returns the column width.
FieldID	getFieldID() Returns the associated FieldID.
char[]	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(FieldID id) Sets the associated FieldID.
void	setSeparator(java.lang.String separator) Sets the characters that are used as separator for the field.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EntryListFieldInfo

public EntryListFieldInfo(FieldID fldID,
                          int ColWidth,
                          java.lang.String separator)
                   throws java.lang.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:

java.lang.IllegalArgumentException - if separator's length exceeds 10

EntryListFieldInfo

public EntryListFieldInfo(FieldID fldID)

Method Detail

getFieldID

public FieldID getFieldID()

Returns the associated FieldID.

setFieldID

public void setFieldID(FieldID 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 char[] getSeparator()

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

setSeparator

public void setSeparator(java.lang.String separator)

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

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

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

Throws:

java.lang.CloneNotSupportedException

equals

public boolean equals(java.lang.Object anObject)

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.

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.