com.remedy.arsys.api
Class SchemaListCriteria

java.lang.Object
  |
  +--com.remedy.arsys.api.ListCriteriaBase
        |
        +--com.remedy.arsys.api.SchemaListCriteria

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

SchemaAliasesCriteria

public class SchemaListCriteria

extends com.remedy.arsys.api.ListCriteriaBase

The SchemaListCriteria class is used to specify the type of schemas to retrieve on a find call.

Field Summary

protected InternalID[]	m_fieldIds
protected NameID	m_schemaName
protected int	m_schemaType

Constructor Summary

SchemaListCriteria()

SchemaListCriteria(SchemaType type, boolean hidden, Timestamp ts, NameID name)

SchemaListCriteria(SchemaType type, boolean hidden, Timestamp ts, NameID name, InternalID[] ids)
Constructs a new SchemaListCriteria object.

Method Summary

java.lang.Object	clone() Clone implementation that returns an Object with data cloned from self.
Timestamp	getModifiedAfter() Returns the time stamp that limits the objects to those modified after the specified time.
void	setModifiedAfter(Timestamp ts) Sets the time stamp that limits the objects to those modified after the specified time.

Methods inherited from class java.lang.Object

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

Field Detail

m_schemaType

protected int m_schemaType

m_schemaName

protected NameID m_schemaName

m_fieldIds

protected InternalID[] m_fieldIds

Constructor Detail

SchemaListCriteria

public SchemaListCriteria()

SchemaListCriteria

public SchemaListCriteria(SchemaType type,
                          boolean hidden,
                          Timestamp ts,
                          NameID name,
                          InternalID[] ids)

Constructs a new SchemaListCriteria object.

Parameters:

ts - A time stamp that limits the schemas retrieved to those modified after the specified time. Specify null for this parameter if you do not want to retrieve schemas with any modification time stamp.

type - A SchemaType object indicating the types of schemas to retrieve.

hidden - A boolean indicating whether to retrieve both visible and hidden schemas. Specifying true means that both visible and hidden schemas will be retrieved.

name - In the case where SchemaType is UPLINK, this parameter specifies the schema upon which the retrieved schemas depend. If the SchemaType is DOWNLINK this parameter specifies the schema that depends on the retrieved schemas. Specify null for other SchemaType.

ids - A list of field ids that limits the schemas retrieved to those that have them

SchemaListCriteria

public SchemaListCriteria(SchemaType type,
                          boolean hidden,
                          Timestamp ts,
                          NameID name)

Method Detail

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.

Overrides:

clone in class java.lang.Object