com.remedy.arsys.api
Class DisplayInstanceList

java.lang.Object
  com.remedy.arsys.api.DisplayInstanceList

All Implemented Interfaces:

java.lang.Cloneable

public class DisplayInstanceList

extends java.lang.Object

implements java.lang.Cloneable

The DisplayInstanceList class defines the display properties of a field for all associated schema views.

Constructor Summary

DisplayInstanceList(PropInfo[] commonProperties, DisplayInstanceInfo[] dInstanceList)
Constructs a new DisplayInstanceList object.

Method Summary

void	clear() Release all variable object references.
java.lang.Object	clone() Clone implementation that returns an Object with data cloned from self.
protected void	finalize() Clears up all variable object references if it is called, even through there is no guarantee to be called.
PropInfo[]	getCommonProperties() Returns the display properties that are common to all schema views.
DisplayInstanceInfo[]	getDisplayInstances() Returns the list of schema views and their associated display properties.
Value	getProperty(InternalID vuiId, java.lang.Integer tag) Returns a property with a certain tag for a specific view.
void	setProperty(InternalID vuiId, int tag, Value value) Sets the value of a property with a specific tag for a specific view.

Methods inherited from class java.lang.Object

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

Constructor Detail

DisplayInstanceList

public DisplayInstanceList(PropInfo[] commonProperties,
                           DisplayInstanceInfo[] dInstanceList)

Constructs a new DisplayInstanceList object.

Parameters:

commonProperties - Display properties that are common to all schema views.

dInstanceList - An array of schema views and their associated display properties.

Method Detail

getCommonProperties

public PropInfo[] getCommonProperties()

Returns the display properties that are common to all schema views.

getDisplayInstances

public DisplayInstanceInfo[] getDisplayInstances()

Returns the list of schema views and their associated display properties.

getProperty

public Value getProperty(InternalID vuiId,
                         java.lang.Integer tag)

Returns a property with a certain tag for a specific view.

setProperty

public void setProperty(InternalID vuiId,
                        int tag,
                        Value value)

Sets the value of a property with a specific tag for a specific view. This method takes an Integer object as a parameter.

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

clear

public void clear()

Release all variable object references. Since most of those references are JNI objects, gc will not reclaim them if we do not release them specificly. Client should call this in their finally block when done with this object.

finalize

protected void finalize()
                 throws java.lang.Throwable

Clears up all variable object references if it is called, even through there is no guarantee to be called. Basically, the finalize method calls clear(). Client should call this in their finally block when done with this object.

Throws:

java.lang.Throwable