com.bmc.arsys.api

Class DataDictionaryMenu

java.lang.Object

com.bmc.arsys.api.ObjectBase

com.bmc.arsys.api.Menu

com.bmc.arsys.api.ServerInfoMenu

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

Constructors

Constructor and Description
DataDictionaryMenu()
DataDictionaryMenu(String server, int nameType, int valueFormat)

Method Summary

Modifier and Type	Method and Description
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:

• Constants.AR_CHAR_MENU_DD_DB_NAME
• Constants.AR_CHAR_MENU_DD_LOCAL_NAME
• Constants.AR_CHAR_MENU_DD_ID

setNameType

public void setNameType(int type)

Sets the type of name for Data-Dictionary menu. You can set the following constant values:

• Constants.AR_CHAR_MENU_DD_DB_NAME
• Constants.AR_CHAR_MENU_DD_LOCAL_NAME
• Constants.AR_CHAR_MENU_DD_ID

getValueFormat

public int getValueFormat()

Returns format type. You can return the following constant values:

• Constants.AR_CHAR_MENU_DD_FORMAT_NONE
• Constants.AR_CHAR_MENU_DD_FORMAT_ID
• Constants.AR_CHAR_MENU_DD_FORMAT_NAME
• Constants.AR_CHAR_MENU_DD_FORMAT_QUOTES
• Constants.AR_CHAR_MENU_DD_FORMAT_DOLLARS
• Constants.AR_CHAR_MENU_DD_FORMAT_ID_NAME
• Constants.AR_CHAR_MENU_DD_FORMAT_NAMEL
• Constants.AR_CHAR_MENU_DD_FORMAT_QUOTESL
• Constants.AR_CHAR_MENU_DD_FORMAT_DOLLARSL
• Constants.AR_CHAR_MENU_DD_FORMAT_ID_L
• Constants.AR_CHAR_MENU_DD_FORMAT_NAME_L
• Constants.AR_CHAR_MENU_DD_FORMAT_L_NAME

setValueFormat

public void setValueFormat(int format)

Sets format type. You can set the following constant values:

• Constants.AR_CHAR_MENU_DD_FORMAT_NONE
• Constants.AR_CHAR_MENU_DD_FORMAT_ID
• Constants.AR_CHAR_MENU_DD_FORMAT_NAME
• Constants.AR_CHAR_MENU_DD_FORMAT_QUOTES
• Constants.AR_CHAR_MENU_DD_FORMAT_DOLLARS
• Constants.AR_CHAR_MENU_DD_FORMAT_ID_NAME
• Constants.AR_CHAR_MENU_DD_FORMAT_NAMEL
• Constants.AR_CHAR_MENU_DD_FORMAT_QUOTESL
• Constants.AR_CHAR_MENU_DD_FORMAT_DOLLARSL
• Constants.AR_CHAR_MENU_DD_FORMAT_ID_L
• Constants.AR_CHAR_MENU_DD_FORMAT_NAME_L
• Constants.AR_CHAR_MENU_DD_FORMAT_L_NAME

getStructType

public int getStructType()

return the DD menu type. It can be one of the following values:

• Constants.AR_CHAR_MENU_DD_FORM
• Constants.AR_CHAR_MENU_DD_FIELD

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