AR System Java API

com.bmc.arsys.api
Class FieldDataDictionaryMenu

java.lang.Object
  extended by com.bmc.arsys.api.ObjectBase
      extended by com.bmc.arsys.api.Menu
          extended by com.bmc.arsys.api.ServerInfoMenu
              extended by com.bmc.arsys.api.DataDictionaryMenu
                  extended by com.bmc.arsys.api.FieldDataDictionaryMenu
All Implemented Interfaces:
IARPersistentObject, Serializable, Cloneable

public class FieldDataDictionaryMenu
extends DataDictionaryMenu
implements Cloneable, Serializable

The CharMenuDDFieldInfo class returns the Data-Dictionary menu field object type. A data dictionary menu pulls values for field objects from the data dictionary. For field objects, you specify the server and form, and the type of fields to use, such as data fields or control fields.

See Also:
Serialized Form

Constructor Summary
FieldDataDictionaryMenu()
           
FieldDataDictionaryMenu(String server, int nameType, int valueFormat, int fieldType, String form)
           
 
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.
 int getFieldType()
          Returns the field type.
 String getForm()
          Returns the form name.
 int hashCode()
          Returns the hash code value for this instance of the current class.
 void setFieldType(int type)
          Sets the field type.
 void setForm(String form)
          Sets the form name.
 String toString()
          Returns a string description of the object.
 
Methods inherited from class com.bmc.arsys.api.DataDictionaryMenu
getNameType, getStructType, getValueFormat, setNameType, setServer, setValueFormat
 
Methods inherited from class com.bmc.arsys.api.ServerInfoMenu
getServer
 
Methods inherited from class com.bmc.arsys.api.Menu
getContent, getKey, getMenuType, getProperties, getRefreshCode, setContent, setKey, setProperties, setRefreshCode
 
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, setPermissions
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

FieldDataDictionaryMenu

public FieldDataDictionaryMenu()

FieldDataDictionaryMenu

public FieldDataDictionaryMenu(String server,
                               int nameType,
                               int valueFormat,
                               int fieldType,
                               String form)
Method Detail

getFieldType

public int getFieldType()
Returns the field type.


getForm

public String getForm()
Returns the form name.


clone

public Object clone()
             throws CloneNotSupportedException
Clone implementation that returns an Object with data cloned from self.

Overrides:
clone in class DataDictionaryMenu
Throws:
CloneNotSupportedException

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 DataDictionaryMenu
Parameters:
obj - the object that we are comparing to
Returns:
returns a boolean that tells if the two objects equal

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 DataDictionaryMenu
Returns:
returns the hash code for this instance

toString

public String toString()
Returns a string description of the object.

Overrides:
toString in class DataDictionaryMenu

setFieldType

public void setFieldType(int type)
Sets the field type.


setForm

public void setForm(String form)
Sets the form name.


AR System Java API

© Copyright 2006, 2007 BMC Software, Inc.