com.remedy.arsys.api
Class EscalationFactory

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

All Implemented Interfaces:

IARObjectFactory

public class EscalationFactory

extends java.lang.Object

implements IARObjectFactory

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

EscalationFactory escalationFactory = EscalationFactory.getFactory( );
      EscalationKey key = new EscalationKey( );
      EscalationCriteria criteria = null;
      if( EscalationKey.GetBoolean( false )
      {
          criteria = new EscalationCriteria( );
          criteria.setRetrieveAll( true );
      }
      Escalation escalation = escalationFactory.findByKey( context, key, criteria );
 

Constructor Summary

protected

EscalationFactory()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

EscalationFactory

protected EscalationFactory()

Method Detail

getFactory

public static EscalationFactory getFactory()

Returns the escalation factory.

newInstance

public java.lang.Object newInstance()

Instantiates a new escalation object in memory.

Specified by:

newInstance in interface IARObjectFactory

releaseInstance

public boolean releaseInstance(java.lang.Object Escalation)

Releases instance of escalation object from memory.

Specified by:

releaseInstance in interface IARObjectFactory

findByKey

public static Escalation findByKey(ARServerUser context,
                                   EscalationKey key,
                                   EscalationCriteria criteria)
                            throws ARException

Returns detailed information about the Escalation object specified by EscalationCriteria and EscalationKey.

Parameters:

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

criteria - A EscalationCriteria object containing the name of the Escalation and the information to retrieve

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if object information is not returned

find

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

Returns a list of Escalation 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 Escalation[] findObjects(ARServerUser context,
                                       WorkflowObjectListCriteria listcriteria,
                                       EscalationCriteria criteria)
                                throws ARException

Returns detailed information for a list of Escalation objects specified by WorkflowObjectListCriteria and EscalationCriteria.

Parameters:

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

listcriteria - A WorkflowObjectListCriteria object

criteria - A EscalationCriteria object

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if information is not returned