com.remedy.arsys.api
Class ActiveLinkFactory

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

All Implemented Interfaces:

IARObjectFactory

public class ActiveLinkFactory

extends java.lang.Object

implements IARObjectFactory

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

ActiveLinkFactory activeLinkFactory = ActiveLinkFactory.getFactory( );
      ActiveLinkKey key = new ActiveLinkKey( );
      ActiveLinkCriteria criteria = new ActiveLinkCriteria( );
      criteria.setRetrieveAll( true );
      ActiveLink activeLink = activeLinkFactory.findByKey( context, key, criteria );
 

Constructor Summary

protected

ActiveLinkFactory()

Method Summary

static ActiveLinkKey[]	find(ARServerUser context, WorkflowObjectListCriteria criteria) Returns a list of active link names specified by WorkflowObjectListCriteria.
static ActiveLink	findByKey(ARServerUser context, ActiveLinkKey key, ActiveLinkCriteria criteria) Returns detailed information about the ActiveLink object specified by ActiveLinkCriteria and ActiveLinkKey.
static ActiveLink[]	findObjects(ARServerUser context, WorkflowObjectListCriteria listcriteria, ActiveLinkCriteria criteria) Returns detailed information for a list of ActiveLink objects specified by WorkflowObjectListCriteria and ActiveLinkCriteria.
static ActiveLinkFactory	getFactory() Returns the active link factory.
java.lang.Object	newInstance() Instantiates a new active link object in memory.
boolean	releaseInstance(java.lang.Object activeLink) Releases instance of active link object from memory.

Methods inherited from class java.lang.Object

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

Constructor Detail

ActiveLinkFactory

protected ActiveLinkFactory()

Method Detail

getFactory

public static ActiveLinkFactory getFactory()

Returns the active link factory.

newInstance

public java.lang.Object newInstance()

Instantiates a new active link object in memory.

Specified by:

newInstance in interface IARObjectFactory

releaseInstance

public boolean releaseInstance(java.lang.Object activeLink)

Releases instance of active link object from memory.

Specified by:

releaseInstance in interface IARObjectFactory

findByKey

public static ActiveLink findByKey(ARServerUser context,
                                   ActiveLinkKey key,
                                   ActiveLinkCriteria criteria)
                            throws ARException

Returns detailed information about the ActiveLink object specified by ActiveLinkCriteria and ActiveLinkKey.

Parameters:

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

criteria - A ActiveLinkCriteria object containing the name of the active link and the information to retrieve

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if information is not returned

find

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

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

Returns detailed information for a list of ActiveLink objects specified by WorkflowObjectListCriteria and ActiveLinkCriteria.

Parameters:

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

listcriteria - A WorkflowObjectListCriteria object

criteria - A ActiveLinkCriteria object

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if information is not returned