com.bmc.arsys.api
Class Menu

java.lang.Object
  com.bmc.arsys.api.ObjectBase
      com.bmc.arsys.api.Menu

All Implemented Interfaces:

IARPersistentObject, Serializable, Cloneable

Direct Known Subclasses:

FileMenu, ListMenu, ServerInfoMenu, SqlMenu

public abstract class Menu
extends ObjectBase
implements Cloneable

The Menu class and methods are used to represent the properties of menu objects.

See Also:

Serialized Form

Constructor Summary

Menu()

Menu(String menuName)

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.
List<MenuItem>	getContent()
String	getKey() Returns the unique identifier for menu.
int	getMenuType()
ObjectPropertyMap	getProperties() Returns all property information of menu.
int	getRefreshCode() Returns when the menu is refreshed.
int	hashCode() Returns the hash code value for this instance of the current class.
void	setContent(List<MenuItem> content)
void	setKey(String key) Sets the unique identifier for menu.
void	setProperties(ObjectPropertyMap props) Sets property information of menu.
void	setRefreshCode(int refreshCode) Sets when the menu is refreshed.
String	toString() Returns a string description of the object.

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

Menu

public Menu()

Menu

public Menu(String menuName)

Method Detail

setRefreshCode

public void setRefreshCode(int refreshCode)

Sets when the menu is refreshed.

Parameters:

refreshCode - This parameter enables you to balance menu consistency with performance. Use one of the following values to indicate when the menu is refreshed:

• 1 - Refresh only when form opened (Constants.AR_MENU_REFRESH_CONNECT).
• 2 - Refresh every time menu opened (Constants.AR_MENU_REFRESH_OPEN).
• 3 - Refresh first time menu opened and every 15 minutes thereafter (Constants.AR_MENU_REFRESH_INTERVAL).

getRefreshCode

public int getRefreshCode()

Returns when the menu is refreshed.

getProperties

public ObjectPropertyMap getProperties()

Returns all property information of menu.

setProperties

public void setProperties(ObjectPropertyMap props)

Sets property information of menu.

getKey

public String getKey()

Returns the unique identifier for menu.

setKey

public void setKey(String key)

Sets the unique identifier for menu.

getContent

public List<MenuItem> getContent()

setContent

public void setContent(List<MenuItem> content)

getMenuType

public int getMenuType()

clone

public Object clone()
             throws CloneNotSupportedException

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

Overrides:

clone in class ObjectBase

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 ObjectBase

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 ObjectBase

Returns:

returns the hash code for this instance

toString

public String toString()

Returns a string description of the object.

Overrides:

toString in class ObjectBase