com.remedy.arsys.api
Class SortInfo

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

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public class SortInfo

extends java.lang.Object

implements java.lang.Cloneable, java.io.Serializable

The SortInfo class specifies the sort order of fields from an entry list. It consists of two elements, a field ID and a sort order.

See Also:

Serialized Form

Field Summary

InternalID	m_fldID The InternalID associated with the field to sort on.
int	m_order An integer value indicating the sort order for the field (1 - ascending, 2 - descending).

Constructor Summary

SortInfo(InternalID id, int order)
Constructs a new SortInfo object.

Method Summary

java.lang.Object	clone() Makes a copy of the object.
boolean	equals(java.lang.Object anObject) Use this method for checking equality.
InternalID	getFieldID() Returns the InternalID of the field to sort on.
int	getSortOrder() Returns the sort order to be applied on the field.
int	hashCode() Returns the hash code value for this instance of the current class.

Methods inherited from class java.lang.Object

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

Field Detail

m_fldID

public InternalID m_fldID

The InternalID associated with the field to sort on.

m_order

public int m_order

An integer value indicating the sort order for the field (1 - ascending, 2 - descending).

Constructor Detail

SortInfo

public SortInfo(InternalID id,
                int order)

Constructs a new SortInfo object.

Parameters:

id - The InternalID associated with the field to sort on.

order - An integer value indicating the sort order for the field (1 - ascending, 2 - descending).

Method Detail

clone

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

Makes a copy of the object.

Throws:

java.lang.CloneNotSupportedException

getFieldID

public InternalID getFieldID()

Returns the InternalID of the field to sort on.

getSortOrder

public int getSortOrder()

Returns the sort order to be applied on the field.

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.