com.remedy.arsys.api
Class ContainerFactory

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

All Implemented Interfaces:

IARObjectFactory

public class ContainerFactory

extends java.lang.Object

implements IARObjectFactory

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

ContainerFactory containerFactory = ContainerFactory.getFactory( );
      ContainerKey key = new ContainerKey( );
      ContainerCriteria criteria = new ContainerCriteria( );
      criteria.setRetrieveAll( true );
      Container container = containerFactory.findByKey( context, key, criteria );
 

Constructor Summary

protected

ContainerFactory()

Method Summary

static ContainerKey[]	find(ARServerUser context, ContainerListCriteria criteria) Returns a list of container names that meets the criteria specified by ContainerListCriteria.
static Container	findByKey(ARServerUser context, ContainerKey key, ContainerCriteria criteria) Returns detailed information about the Container object specified by ContainerKey and ContainerCriteria.
static Container[]	findObjects(ARServerUser context, ContainerListCriteria listcriteria, ContainerCriteria criteria) Returns detailed information for a list of Container objects specified by ContainerListCriteria and ContainerCriteria.
static Container[]	findObjects(ARServerUser context, ContainerMultiCriteria multicriteria, ContainerCriteria criteria) Returns detailed information for a list of Container objects specified by ContainerListCriteria and ContainerCriteria.
static ContainerFactory	getFactory() Returns the container factory.
java.lang.Object	newInstance() Instantiates a new container object in memory.
boolean	releaseInstance(java.lang.Object container) Releases instance of container object from memory.

Methods inherited from class java.lang.Object

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

Constructor Detail

ContainerFactory

protected ContainerFactory()

Method Detail

newInstance

public java.lang.Object newInstance()

Instantiates a new container object in memory.

Specified by:

newInstance in interface IARObjectFactory

releaseInstance

public boolean releaseInstance(java.lang.Object container)

Releases instance of container object from memory.

Specified by:

releaseInstance in interface IARObjectFactory

getFactory

public static ContainerFactory getFactory()

Returns the container factory.

findByKey

public static Container findByKey(ARServerUser context,
                                  ContainerKey key,
                                  ContainerCriteria criteria)
                           throws ARException

Returns detailed information about the Container object specified by ContainerKey and ContainerCriteria.

Parameters:

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

key - A ContainerKey object that uniquely identifies a container of the AR System server

criteria - A ContainerCriteria object containing the information to retrieve

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if information is not returned

find

public static ContainerKey[] find(ARServerUser context,
                                  ContainerListCriteria criteria)
                           throws ARException

Returns a list of container names that meets the criteria specified by ContainerListCriteria.

Parameters:

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

criteria - A ContainerListCriteria object that specifies the container to return

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if list is not returned

findObjects

public static Container[] findObjects(ARServerUser context,
                                      ContainerListCriteria listcriteria,
                                      ContainerCriteria criteria)
                               throws ARException

Returns detailed information for a list of Container objects specified by ContainerListCriteria and ContainerCriteria.

Parameters:

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

listcriteria - A ContainerListCriteria object that specifies the container to return

criteria - A ContainerCriteria object containing the information to return

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if information is not returned

findObjects

public static Container[] findObjects(ARServerUser context,
                                      ContainerMultiCriteria multicriteria,
                                      ContainerCriteria criteria)
                               throws ARException

Returns detailed information for a list of Container objects specified by ContainerListCriteria and ContainerCriteria.

Parameters:

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

multicriteria - A ContainerMultiCriteria object that specifies the containers to return

criteria - A ContainerCriteria object containing the information to return

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if information is not returned