com.remedy.arsys.api
Class IndexInfo

java.lang.Object
  |
  +--com.remedy.arsys.api.IndexInfo

public class IndexInfo

extends java.lang.Object

implements java.lang.Cloneable

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

Constructor Summary

IndexInfo(InternalID[] ids, boolean unique, NameID name)
Constructs a new IndexInfo object.

Method Summary

java.lang.Object	clone() Makes a copy of the object.
InternalID[]	getIndexFields() Returns fields indexed for schema.
NameID	getIndexName() Returns name of index.
boolean	isUnique() Returns list of fields with unique indexes.
void	setIndexFields(InternalID[] ids) Sets fields indexed for schema.
void	setIndexName(NameID name) Sets name of index.
void	setIsUniqueFlag(boolean flag) Sets unique index on fields.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IndexInfo

public IndexInfo(InternalID[] ids,
                 boolean unique,
                 NameID 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 InternalID[] getIndexFields()

Returns fields indexed for schema.

setIndexFields

public void setIndexFields(InternalID[] ids)

Sets fields indexed for schema.

isUnique

public boolean isUnique()

Returns list of fields with unique indexes.

setIsUniqueFlag

public void setIsUniqueFlag(boolean flag)

Sets unique index on fields.

getIndexName

public NameID getIndexName()

Returns name of index.

setIndexName

public void setIndexName(NameID name)

Sets name of index.

clone

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

Makes a copy of the object.

Overrides:

clone in class java.lang.Object