AR System Java API

com.bmc.arsys.api
Class DataDictionaryMenu

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
All Implemented Interfaces:
IARPersistentObject, Serializable, Cloneable
Direct Known Subclasses:
FieldDataDictionaryMenu, FormDataDictionaryMenu

public abstract class DataDictionaryMenu
extends ServerInfoMenu
implements Cloneable, Serializable

The DataDictionaryMenu class returns information for a Data-Dictionary menu.

See Also:
Serialized Form

Constructor Summary
DataDictionaryMenu()
           
DataDictionaryMenu(String server, int nameType, int valueFormat)
           
 
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 getNameType()
          Returns the type of name for Data-Dictionary menu.
 int getStructType()
          return the DD menu type.
 int getValueFormat()
          Returns format type.
 int hashCode()
          Returns the hash code value for this instance of the current class.
 void setNameType(int type)
          Sets the type of name for Data-Dictionary menu.
 void setServer(String server)
          Sets the server where Data-Dictionary menu is located
 void setValueFormat(int format)
          Sets format type.
 String toString()
          Returns a string description of the object.
 
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

DataDictionaryMenu

public DataDictionaryMenu()

DataDictionaryMenu

public DataDictionaryMenu(String server,
                          int nameType,
                          int valueFormat)
Method Detail

setServer

public void setServer(String server)
Sets the server where Data-Dictionary menu is located

Parameters:
server -

getNameType

public int getNameType()
Returns the type of name for Data-Dictionary menu. You can return the following constant values:


setNameType

public void setNameType(int type)
Sets the type of name for Data-Dictionary menu. You can set the following constant values:


getValueFormat

public int getValueFormat()
Returns format type. You can return the following constant values:


setValueFormat

public void setValueFormat(int format)
Sets format type. You can set the following constant values:


getStructType

public int getStructType()
return the DD menu type. It can be one of the following values:


clone

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

Overrides:
clone in class ServerInfoMenu
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 ServerInfoMenu
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 ServerInfoMenu
Returns:
returns the hash code for this instance

toString

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

Overrides:
toString in class ServerInfoMenu

AR System Java API

© Copyright 2006, 2007 BMC Software, Inc.