com.bmc.arsys.api

Class IndexInfo

java.lang.Object

com.bmc.arsys.api.IndexInfo

All Implemented Interfaces:

Serializable, Cloneable

public class IndexInfo
extends Object
implements Cloneable, Serializable

The IndexInfo class defines which fields are indexed on the form.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IndexInfo()
IndexInfo(List<Integer> ids, boolean unique, String name) Constructs a new IndexInfo object.

Method Summary

Modifier and Type	Method and Description
Object	clone() Makes a copy of the object.
boolean	equals(Object obj) Use this method for checking equality.
List<Integer>	getIndexFields() Returns fields indexed for form.
String	getIndexName() Returns name of index.
int	hashCode() Returns the hash code value for this instance of the current class.
boolean	isUnique() Returns list of fields with unique indexes.
void	setIndexFields(List<Integer> ids) Sets fields indexed for form.
void	setIndexName(String name) Sets name of index.
void	setUnique(boolean flag) Sets unique index on fields.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

IndexInfo

public IndexInfo()

IndexInfo

public IndexInfo(List<Integer> ids,
                 boolean unique,
                 String name)

Constructs a new IndexInfo object.

Parameters:

ids - The InternalID of the fields.

unique - A boolean value to indicate whether the index is unique.

name - Name of the index.

Method Detail

getIndexFields

public List<Integer> getIndexFields()

Returns fields indexed for form.

setIndexFields

public void setIndexFields(List<Integer> ids)

Sets fields indexed for form.

isUnique

public boolean isUnique()

Returns list of fields with unique indexes.

setUnique

public void setUnique(boolean flag)

Sets unique index on fields.

getIndexName

public String getIndexName()

Returns name of index.

setIndexName

public void setIndexName(String name)

Sets name of index.

clone

public Object clone()
             throws CloneNotSupportedException

Makes a copy of the object.

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