com.remedy.arsys.api
Class Menu

java.lang.Object
  |
  +--com.remedy.arsys.api.ObjectBase
        |
        +--com.remedy.arsys.api.Menu

public class Menu

extends ObjectBase

implements IARPersistentObject, java.lang.Cloneable

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

Fields inherited from class com.remedy.arsys.api.ObjectBase

m_changeFlags

Method Summary

void	activate() Remedy reserved method.
void	clear() Clears all of the references to member objects.
java.lang.Object	clone() Clone implementation that returns an Object with data cloned from self.
void	create() Creates this object on the AR System server.
CharMenuInfo	expandMenu() Expands the query and file references for the specified menu definition and returns a character menu with list-type items only.
MenuKey	getKey() Returns the unique identifier for menu.
CharMenuInfo	getMenuDefinition() Returns the definition of the menu.
PropInfo[]	getProperties() Returns all property information of menu.
int	getRefreshCode() Returns when the menu is refreshed..
void	load() Populates this object with information from the AR System server.
void	load(MenuCriteria criteria) Populates this object with information specified by MenuCriteria from the AR System server.
void	passivate() Remedy reserved method.
void	remove() Removes this object on the AR System server.
void	setContext(ARServerUser ctxt) Associates ARServerUser information with this AR System server object.
void	setKey(MenuKey key) Sets the unique identifier for menu.
void	setMenuDefinition(CharMenuInfo menu) Sets the definition of the menu.
void	setProperties(PropInfo[] props) Sets property information of menu.
void	setRefreshCode(int refreshCode) Sets when the menu is refreshed.
void	store() Saves the changes made to this object specified by MenuCriteria on the AR System server.
void	unsetContext() Removes the association to a specific user context.

Methods inherited from class com.remedy.arsys.api.ObjectBase

getDiary, getHelpText, getLastChangedBy, getLastUpdateTime, getName, getNewName, getOwner, getPermissions, resetChangeFlags, setDiary, setHelpText, setLastChangedBy, setName, setNewName, setOwner, setPermissions

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setRefreshCode

public void setRefreshCode(int refreshCode)

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

Parameters:

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..

setMenuDefinition

public void setMenuDefinition(CharMenuInfo menu)

Sets the definition of the menu.

getMenuDefinition

public CharMenuInfo getMenuDefinition()

Returns the definition of the menu.

getProperties

public PropInfo[] getProperties()

Returns all property information of menu.

setProperties

public void setProperties(PropInfo[] props)

Sets property information of menu.

getKey

public MenuKey getKey()

Returns the unique identifier for menu.

setKey

public void setKey(MenuKey key)

Sets the unique identifier for menu.

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

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

Overrides:

clone in class ObjectBase

expandMenu

public CharMenuInfo expandMenu()
                        throws ARException

Expands the query and file references for the specified menu definition and returns a character menu with list-type items only.

create

public void create()
            throws ARException

Creates this object on the AR System server.

Specified by:

create in interface IARPersistentObject

remove

public void remove()
            throws ARException

Removes this object on the AR System server.

Specified by:

remove in interface IARPersistentObject

load

public void load()
          throws ARException

Populates this object with information from the AR System server.

Specified by:

load in interface IARPersistentObject

load

public void load(MenuCriteria criteria)
          throws ARException

Populates this object with information specified by MenuCriteria from the AR System server.

store

public void store()
           throws ARException

Saves the changes made to this object specified by MenuCriteria on the AR System server.

Specified by:

store in interface IARPersistentObject

activate

public void activate()

Remedy reserved method.

Specified by:

activate in interface IARPersistentObject

passivate

public void passivate()

Remedy reserved method.

Specified by:

passivate in interface IARPersistentObject

setContext

public void setContext(ARServerUser ctxt)

Associates ARServerUser information with this AR System server object.

Specified by:

setContext in interface IARPersistentObject

unsetContext

public void unsetContext()

Removes the association to a specific user context.

Specified by:

unsetContext in interface IARPersistentObject

clear

public void clear()

Clears all of the references to member objects.

Specified by:

clear in interface IARPersistentObject

Overrides:

clear in class ObjectBase