com.bmc.arsys.api
Class ViewForm

java.lang.Object
  com.bmc.arsys.api.ObjectBase
      com.bmc.arsys.api.Form
          com.bmc.arsys.api.ViewForm

All Implemented Interfaces:

IARPersistentObject, Serializable, Cloneable

public class ViewForm
extends Form
implements Cloneable, Serializable

The ViewForm class represents a type of "external" form that is created from a non-AR System database source, for example, an MS Access database.

See Also:

Serialized Form

Constructor Summary

ViewForm()

ViewForm(String table, String key)

Method Summary

Object	clone() Clone implementation that returns an Object with data cloned from self.
boolean	equals(Object obj) Use this method for checking equality between the current object and the provided one.
String	getKeyField() Returns the primary field Entry ID (entryId(C1)) that the external table maps to.
String	getTableName() Returns the name of the external table.
int	hashCode() Returns the hash code value for this instance of the current class.
void	setKeyField(String keyField)
void	setTableName(String tableName)
String	toString() Returns a string description of the object.

Methods inherited from class com.bmc.arsys.api.Form

getAdminGrpList, getArchiveInfo, getAssignedGroup, getAuditInfo, getDefaultVUI, getEntryListFieldInfo, getFormType, getIndexInfo, getKey, getProperties, getSortInfo, setAdminGrpList, setArchiveInfo, setAuditInfo, setDefaultVUI, setDeleteOption, setEntryListFieldInfo, setIndexInfo, setKey, setPermissions, setProperties, setSortInfo

Methods inherited from class com.bmc.arsys.api.ObjectBase

appendDiaryText, clear, getChangeFlags, getDiary, getHelpText, getLastChangedBy, getLastUpdateTime, getName, getNewName, getOwner, getPermissions, setChangeFlags, setDiary, setDiary, setHelpText, setLastChangedBy, setName, setNewName, setOwner

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ViewForm

public ViewForm()

ViewForm

public ViewForm(String table,
                String key)

Method Detail

clone

public Object clone()
             throws CloneNotSupportedException

Clone implementation that returns an Object with data cloned from self.

Overrides:

clone in class Form

Throws:

CloneNotSupportedException

getTableName

public String getTableName()

Returns the name of the external table.

getKeyField

public String getKeyField()

Returns the primary field Entry ID (entryId(C1)) that the external table maps to.

toString

public String toString()

Returns a string description of the object.

Overrides:

toString in class Form

hashCode

public int hashCode()

Returns the hash code value for this instance of the current class. This method is supported as required by the general contract of Object.hashCode, for the benefit of hash tables such as those provided by java.util.Hashtable.

Overrides:

hashCode in class Form

Returns:

returns the hash code for this instance

equals

public boolean equals(Object obj)

Use this method for checking equality between the current object and the provided one. The result is true only if the argument is not null, is of the same type and represents the same content.

Overrides:

equals in class Form

Parameters:

obj - the object that we are comparing to

Returns:

returns a boolean that tells if the two objects equal

setKeyField

public void setKeyField(String keyField)

setTableName

public void setTableName(String tableName)