AR System Java API

com.bmc.arsys.api
Class SortInfo

java.lang.Object
  extended by com.bmc.arsys.api.SortInfo
All Implemented Interfaces:
Serializable, Cloneable

public class SortInfo
extends Object
implements Cloneable, 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
 int 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()
           
SortInfo(int id, int order)
          Constructs a new SortInfo object.
SortInfo(int id, IQuerySource source, int order)
          Constructs a new SortInfo object used by dynamic queries.
 
Method Summary
 Object clone()
          Makes a copy of the object.
 boolean equals(Object obj)
          Use this method for checking equality.
 int getFieldID()
          Returns the fieldID to sort on.
 int getSortOrder()
          Returns the sort order to be applied on the field.
 IQuerySource getSource()
          Returns the IQuerySource form or query containing the field to sort on
 int hashCode()
          Returns the hash code value for this instance of the current class.
 String toString()
           
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

m_fldID

public int 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()

SortInfo

public SortInfo(int 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).

SortInfo

public SortInfo(int id,
                IQuerySource source,
                int order)
Constructs a new SortInfo object used by dynamic queries.

Parameters:
id - The InternalID associated with the field to sort on.
source - The IQuerySource 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 Object clone()
             throws CloneNotSupportedException
Makes a copy of the object.

Overrides:
clone in class Object
Throws:
CloneNotSupportedException

getFieldID

public int getFieldID()
Returns the fieldID to sort on.


getSortOrder

public int getSortOrder()
Returns the sort order to be applied on the field.


getSource

public IQuerySource getSource()
Returns the IQuerySource form or query containing the field to sort on


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

AR System Java API

© Copyright 2006, 2007 BMC Software, Inc.