com.remedy.arsys.api
Class EntryListCriteria

java.lang.Object
  com.remedy.arsys.api.ListCriteriaBase
      com.remedy.arsys.api.EntryListCriteria

All Implemented Interfaces:

java.lang.Cloneable

public class EntryListCriteria

extends com.remedy.arsys.api.ListCriteriaBase

The EntryListCriteria class is used to define the criteria for selecting a list of entries from AR System.

Constructor Summary

EntryListCriteria()

EntryListCriteria(NameID schID, QualifierInfo qual, int limit, Timestamp ts, SortInfo[] sInfos, EntryID[] entries)

EntryListCriteria(NameID schID, QualifierInfo qual, long firstRetrieve, int limit, Timestamp ts, SortInfo[] sInfos, EntryID[] entries)

Method Summary

java.lang.Object	clone() Clone implementation that returns an Object with data cloned from self.
EntryID[]	getEntriesToRetrieve() Returns the list of specific entries to be retrieved.
long	getFirstRetrieve() Returns the index of the first entry that should be retrieved.
int	getMaxLimit() Returns the maximum number of entries to be retrieved.
Timestamp	getModifiedAfter() Returns the time stamp that limits the objects to those modified after the specified time.
QualifierInfo	getQualifier() Returns the associated qualification QualifierInfo information
NameID	getSchemaID() Returns the schema ID.
SortInfo[]	getSortInfos() Returns list of zero or more fields (SortInfo) that identifies the entry sort order.
void	setEntriesToRetrieve(EntryID[] entIDs) Sets the list of specific entries to be retrieved.
void	setFirstRetrieve(long firstRetrieve) Sets the index of the first entry that should be retrieved.
void	setMaxLimit(int nLimit) Sets the maximum number of entries to retrieve.
void	setModifiedAfter(Timestamp ts) Sets the time stamp that limits the objects to those modified after the specified time.
void	setQualifier(QualifierInfo qual) Sets the associated qualification QualifierInfo information
void	setSchemaID(NameID schID) Sets the schema ID.
void	setSortInfos(SortInfo[] sInfos) Sets list of zero or more fields (SortInfo) that identifies the entry sort order.

Methods inherited from class java.lang.Object

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

Constructor Detail

EntryListCriteria

public EntryListCriteria()

EntryListCriteria

public EntryListCriteria(NameID schID,
                         QualifierInfo qual,
                         int limit,
                         Timestamp ts,
                         SortInfo[] sInfos,
                         EntryID[] entries)

EntryListCriteria

public EntryListCriteria(NameID schID,
                         QualifierInfo qual,
                         long firstRetrieve,
                         int limit,
                         Timestamp ts,
                         SortInfo[] sInfos,
                         EntryID[] entries)

Method Detail

getSchemaID

public NameID getSchemaID()

Returns the schema ID.

setSchemaID

public void setSchemaID(NameID schID)

Sets the schema ID.

getQualifier

public QualifierInfo getQualifier()

Returns the associated qualification QualifierInfo information

setQualifier

public void setQualifier(QualifierInfo qual)

Sets the associated qualification QualifierInfo information

getFirstRetrieve

public long getFirstRetrieve()

Returns the index of the first entry that should be retrieved. Use constant Constants.AR_START_WITH_FIRST_ENTRY to retrieve from result set starting with the first entry.

setFirstRetrieve

public void setFirstRetrieve(long firstRetrieve)

Sets the index of the first entry that should be retrieved. Use constant Constants.AR_START_WITH_FIRST_ENTRY to set the first entry.

getMaxLimit

public int getMaxLimit()

Returns the maximum number of entries to be retrieved.

setMaxLimit

public void setMaxLimit(int nLimit)

Sets the maximum number of entries to retrieve. Use this parameter to limit the amount of data returned if the qualification does not sufficiently narrow the list. Specify 0 (Constants.AR_NO_MAX_LIST_RETRIEVE) to assign no maximum.

getSortInfos

public SortInfo[] getSortInfos()

Returns list of zero or more fields (SortInfo) that identifies the entry sort order.

setSortInfos

public void setSortInfos(SortInfo[] sInfos)

Sets list of zero or more fields (SortInfo) that identifies the entry sort order. The system generates an error if you do not have read access on all specified fields. Specify NULL for this parameter (or zero fields) to use the default sort order for the schema. The system sorts the entries in ascending order by entryId if the schema has no default sort order.

getEntriesToRetrieve

public EntryID[] getEntriesToRetrieve()

Returns the list of specific entries to be retrieved.

setEntriesToRetrieve

public void setEntriesToRetrieve(EntryID[] entIDs)

Sets the list of specific entries to be retrieved. In case of an invalid Entry ID, EntryFactory.findObjects returns entry object with a flag set to false. Entry.isPresent

setModifiedAfter

public void setModifiedAfter(Timestamp ts)

Sets the time stamp that limits the objects to those modified after the specified time.

getModifiedAfter

public Timestamp getModifiedAfter()

Returns the time stamp that limits the objects to those modified after the specified time.

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