com.bmc.arsys.api

Class FormDataDictionaryMenu

java.lang.Object

com.bmc.arsys.api.ObjectBase

com.bmc.arsys.api.Menu

com.bmc.arsys.api.ServerInfoMenu

com.bmc.arsys.api.DataDictionaryMenu

com.bmc.arsys.api.FormDataDictionaryMenu

All Implemented Interfaces:

IARPersistentObject, Serializable, Cloneable

public class FormDataDictionaryMenu
extends DataDictionaryMenu
implements Cloneable, Serializable

The FormDataDictionaryMenu class returns the Data-Dictionary menu form object type. A data dictionary menu pulls values for form objects from the data dictionary. For form objects, you specify the server and the type of forms to use, such as regular forms or join forms, and whether to include hidden forms.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FormDataDictionaryMenu()
FormDataDictionaryMenu(String server, int nameType, int valueFormat, int formType, boolean includeHidden)

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	getFormType() Returns type of form.
int	hashCode() Returns the hash code value for this instance of the current class.
boolean	isIncludeHidden() Returns a boolean value that includes whether a form is hidden or not.
void	setFormType(int type) Sets type of form.
void	setIncludeHidden(boolean includeHidden) Sets a boolean value that includes whether a form is hidden or not: 0 = false, 1 = true.
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

FormDataDictionaryMenu

public FormDataDictionaryMenu()

FormDataDictionaryMenu

public FormDataDictionaryMenu(String server,
                              int nameType,
                              int valueFormat,
                              int formType,
                              boolean includeHidden)

Method Detail

getFormType

public int getFormType()

Returns type of form. The following constants are returned:

• Constants.AR_CHAR_MENU_DD_NONE -- None.
• Constants.AR_CHAR_MENU_DD_FORM -- Form.

isIncludeHidden

public boolean isIncludeHidden()

Returns a boolean value that includes whether a form is hidden or not.

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

setFormType

public void setFormType(int type)

Sets type of form. The following constants are valid:

• Constants.AR_CHAR_MENU_DD_NONE -- None.
• Constants.AR_CHAR_MENU_DD_FORM -- Form.

setIncludeHidden

public void setIncludeHidden(boolean includeHidden)

Sets a boolean value that includes whether a form is hidden or not: 0 = false, 1 = true.