com.remedy.arsys.api
Class FilterFactory

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

All Implemented Interfaces:

IARObjectFactory

public class FilterFactory

extends java.lang.Object

implements IARObjectFactory

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

FilterFactory filterFactory = FilterFactory.getFactory( );
      FilterKey key = new FilterKey( );
      FilterCriteria criteria = null;
      if( FilterKey.GetBoolean( false )
      {
          criteria = new FilterCriteria( );
          criteria.setRetrieveAll( true );
      }
      Filter filter = filterFactory.findByKey( context, key, criteria );
 

Constructor Summary

protected

FilterFactory()

Method Summary

static FilterKey[]	find(ARServerUser context, WorkflowObjectListCriteria criteria) Returns a list of Filter names specified by WorkflowObjectListCriteria.
static Filter	findByKey(ARServerUser context, FilterKey key, FilterCriteria criteria) Returns detailed information about the Filter object specified by FilterCriteria and FilterKey.
static Filter[]	findObjects(ARServerUser context, WorkflowObjectListCriteria listcriteria, FilterCriteria criteria) Returns detailed information for a list of Filter objects specified by WorkflowObjectListCriteria and FilterCriteria.
static FilterFactory	getFactory() Returns the filter factory.
java.lang.Object	newInstance() Instantiates a new filter object in memory.
boolean	releaseInstance(java.lang.Object Filter) Releases instance of filter object from memory.

Methods inherited from class java.lang.Object

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

Constructor Detail

FilterFactory

protected FilterFactory()

Method Detail

getFactory

public static FilterFactory getFactory()

Returns the filter factory.

newInstance

public java.lang.Object newInstance()

Instantiates a new filter object in memory.

Specified by:

newInstance in interface IARObjectFactory

releaseInstance

public boolean releaseInstance(java.lang.Object Filter)

Releases instance of filter object from memory.

Specified by:

releaseInstance in interface IARObjectFactory

findByKey

public static Filter findByKey(ARServerUser context,
                               FilterKey key,
                               FilterCriteria criteria)
                        throws ARException

Returns detailed information about the Filter object specified by FilterCriteria and FilterKey.

Parameters:

context - A ARServerUser object containing user name, password, server name and language information

criteria - A FilterCriteria object containing the name of the Filter and the information to retrieve

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if information is not returned

find

public static FilterKey[] find(ARServerUser context,
                               WorkflowObjectListCriteria criteria)
                        throws ARException

Returns a list of Filter names specified by WorkflowObjectListCriteria.

Parameters:

context - A ARServerUser object containing user name, password, server name and language information

criteria - A WorkflowObjectListCriteria object

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if list is not returned

findObjects

public static Filter[] findObjects(ARServerUser context,
                                   WorkflowObjectListCriteria listcriteria,
                                   FilterCriteria criteria)
                            throws ARException

Returns detailed information for a list of Filter objects specified by WorkflowObjectListCriteria and FilterCriteria.

Parameters:

context - A ARServerUser object containing user name, password, server name and language information

listcriteria - A WorkflowObjectListCriteria object

criteria - A FilterCriteria object

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if information is not returned