com.remedy.arsys.api
Class MenuFactory

java.lang.Object
  com.remedy.arsys.api.MenuFactory

All Implemented Interfaces:

IARObjectFactory

public class MenuFactory

extends java.lang.Object

implements IARObjectFactory

The methods in the MenuFactory class are used to instantiate a new menu object or to get an existing menu from the server. You then define the properties of the object, and then you can perform different operations (e.g. set/create/delete) on the object from the server side.

The following Java code snippet is an example of how to get a menu object that is existing on the server:

MenuFactory menuFactory = MenuFactory.getFactory( );
      MenuKey key = new MenuKey( );
      MenuCriteria crit = new MenuCriteria();
          if( crit != null )
          {
                crit.setRetrieveAll(true);
          }
      Menu menu = menuFactory.findByKey( context, key, criteria );
 

Method Summary

static MenuKey[]	find(ARServerUser context, MenuListCriteria criteria) Returns a list of menu names specified by MenuListCriteria.
static Menu	findByKey(ARServerUser context, MenuKey key, MenuCriteria criteria) Returns detailed information about the menu object specified by MenuCriteria and MenuKey.
static Menu[]	findObjects(ARServerUser context, MenuListCriteria listCrit, MenuCriteria crit) Returns detailed information for a list of Menu objects specified by MenuListCriteria and MenuCriteria.
static MenuFactory	getFactory() Returns the menu factory.
java.lang.Object	newInstance() Instantiates a new menu object in memory.
boolean	releaseInstance(java.lang.Object obj) Releases instance of menu object from memory.

Methods inherited from class java.lang.Object

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

Method Detail

getFactory

public static MenuFactory getFactory()

Returns the menu factory.

newInstance

public java.lang.Object newInstance()

Instantiates a new menu object in memory.

Specified by:

newInstance in interface IARObjectFactory

releaseInstance

public boolean releaseInstance(java.lang.Object obj)

Releases instance of menu object from memory.

Specified by:

releaseInstance in interface IARObjectFactory

findByKey

public static Menu findByKey(ARServerUser context,
                             MenuKey key,
                             MenuCriteria criteria)
                      throws ARException

Returns detailed information about the menu object specified by MenuCriteria and MenuKey.

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if information is not returned

find

public static MenuKey[] find(ARServerUser context,
                             MenuListCriteria criteria)
                      throws ARException

Returns a list of menu names specified by MenuListCriteria.

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if list is not returned

findObjects

public static Menu[] findObjects(ARServerUser context,
                                 MenuListCriteria listCrit,
                                 MenuCriteria crit)
                          throws ARException

Returns detailed information for a list of Menu objects specified by MenuListCriteria and MenuCriteria.

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if information is not returned