com.remedy.arsys.api
Class FieldListCriteria

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

All Implemented Interfaces:

java.lang.Cloneable

public class FieldListCriteria

extends com.remedy.arsys.api.ListCriteriaBase

implements java.lang.Cloneable

The FieldListCriteria class is used to get or set a list of fields that match specified criteria.

Constructor Summary

FieldListCriteria(NameID name, FieldID[] ids)
Constructs a FieldListCriteria object to be passed as parameter to find or findObjects call on a FieldFactory object.

FieldListCriteria(NameID name, Timestamp timestamp, int type)
Constructs a FieldListCriteria object to be passed as parameter to find or findObjects call on a FieldFactory object.

Method Summary

java.lang.Object	clone() Clone implementation that returns an Object with data cloned from self.
FieldID[]	getFieldIDs() Returns list of field IDs.
Timestamp	getModifiedAfter() Returns the time stamp that limits the objects to those modified after the specified time.
NameID	getSchemaName() Returns name of schema that contains the fields.
void	setFieldIDs(FieldID[] ids) Sets list of field IDs.
void	setFieldTypeToRetrieve(int type) Sets the types of fields to retrieve when calling FieldFactory.find or FieldFactory.findObjects.
void	setModifiedAfter(Timestamp ts) Sets the time stamp that limits the objects to those modified after the specified time.
void	setSchemaName(NameID name) Sets name of schema that contains the fields.

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldListCriteria

public FieldListCriteria(NameID name,
                         Timestamp timestamp,
                         int type)

Constructs a FieldListCriteria object to be passed as parameter to find or findObjects call on a FieldFactory object.

Parameters:

name - Name of schema to retrieve fields for.

timestamp - A time stamp that limits the fields retrieved to those modified after the specified time. Specify a Timestamp with value 0 if you want to retrieve fields with any modification time stamp.

type - Specifies the types of fields to retrieve.

FieldListCriteria

public FieldListCriteria(NameID name,
                         FieldID[] ids)

Constructs a FieldListCriteria object to be passed as parameter to find or findObjects call on a FieldFactory object.

Parameters:

name - Name of schema to retrieve fields for.

ids - Array of FieldID representing the list of fields to retrieve.

Method Detail

setFieldTypeToRetrieve

public void setFieldTypeToRetrieve(int type)

Sets the types of fields to retrieve when calling FieldFactory.find or FieldFactory.findObjects. To specify a combination of field types, use the bitwise OR operator (|).

Parameters:

type - Field type.
Possible values are:

• FieldType.AR_DATA_FIELD: Data fields
• FieldType.AR_TRIM_FIELD: Trim fields
• FieldType.AR_CONTROL_FIELD: Control fields
• FieldType.AR_PAGE_FIELD: Page fields
• FieldType.AR_PAGE_HOLDER_FIELD: Page holder fields
• FieldType.AR_TABLE_FIELD: Table fields
• FieldType.AR_COLUMN_FIELD: Column fields
• FieldType.AR_ALL_FIELD: All fields

setSchemaName

public void setSchemaName(NameID name)

Sets name of schema that contains the fields.

getSchemaName

public NameID getSchemaName()

Returns name of schema that contains the fields.

setFieldIDs

public void setFieldIDs(FieldID[] ids)

Sets list of field IDs.

getFieldIDs

public FieldID[] getFieldIDs()

Returns list of field IDs.

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

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.