com.remedy.arsys.api
Class ViewFactory

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

All Implemented Interfaces:

IARObjectFactory

public class ViewFactory

extends java.lang.Object

implements IARObjectFactory

The methods in the ViewFactory class are used to instantiate a new view object or to get an existing view 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 view object that is existing on the server:

ViewFactory viewFactory = ViewFactory.getFactory( );
      ViewKey key = new ViewKey( );
      ViewCriteria criteria = null;
      if( ViewKey.GetBoolean( false )
      {
          criteria = new ViewCriteria( );
          criteria.setRetrieveAll( true );
      }
      View view = viewFactory.findByKey( context, key, criteria );
 

Constructor Summary

protected

ViewFactory()

Method Summary

static ViewKey[]	find(ARServerUser context, ViewListCriteria criteria) Returns a list of View names.
static View	findByKey(ARServerUser context, ViewKey key, ViewCriteria criteria) Returns detailed information about the View object specified by ViewCriteria and ViewKey.
static View[]	findObjects(ARServerUser context, ViewListCriteria listCriteria, ViewCriteria criteria) Returns a list of View objects specified by ViewListCriteria and ViewCriteria.
static ViewFactory	getFactory() Returns the view factory.
java.lang.Object	newInstance() Instantiates a new view object in memory.
boolean	releaseInstance(java.lang.Object obj) Releases instance of view object from memory.

Methods inherited from class java.lang.Object

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

Constructor Detail

ViewFactory

protected ViewFactory()

Method Detail

getFactory

public static ViewFactory getFactory()

Returns the view factory.

newInstance

public java.lang.Object newInstance()

Instantiates a new view object in memory.

Specified by:

newInstance in interface IARObjectFactory

releaseInstance

public boolean releaseInstance(java.lang.Object obj)

Releases instance of view object from memory.

Specified by:

releaseInstance in interface IARObjectFactory

findByKey

public static View findByKey(ARServerUser context,
                             ViewKey key,
                             ViewCriteria criteria)
                      throws ARException

Returns detailed information about the View object specified by ViewCriteria and ViewKey.

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if information is not found

find

public static ViewKey[] find(ARServerUser context,
                             ViewListCriteria criteria)
                      throws ARException

Returns a list of View names.

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if list is not found

findObjects

public static View[] findObjects(ARServerUser context,
                                 ViewListCriteria listCriteria,
                                 ViewCriteria criteria)
                          throws ARException

Returns a list of View objects specified by ViewListCriteria and ViewCriteria.

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if list is not found