com.remedy.arsys.api
Class SupportFileFactory

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

All Implemented Interfaces:

IARObjectFactory

public class SupportFileFactory

extends java.lang.Object

implements IARObjectFactory

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

SupportFileFactory supportFileFactory = SupportFileFactory.getFactory( );
      SupportFileKey key = new SupportFileKey( );
      SupportFileCriteria criteria = new SupportFileCriteria( );
      criteria.setRetrieveAll( true );
      SupportFile supportFile = supportFileFactory.findByKey( context, key, criteria );
 

Constructor Summary

protected

SupportFileFactory()

Method Summary

static SupportFileKey[]	find(ARServerUser context, SupportFileListCriteria criteria) Returns a list of SupportFileKey objects that contain the details of the support files specified by SupportFileListCriteria.
static SupportFile	findByKey(ARServerUser context, SupportFileKey key, SupportFileCriteria criteria) Returns detailed information about the SupportFile object specified by SupportFileCriteria and SupportFileKey.
static SupportFile[]	findObjects(ARServerUser context, SupportFileListCriteria listcriteria, SupportFileCriteria criteria) Returns a list of SupportFile objects that matches the search criteria given in the SupportFileListCriteria.
java.lang.String	getDefaultOutputDirectory() Returns the default output directory where support file is is to be retrieved.
static SupportFileFactory	getFactory() Returns the support file factory.
java.lang.Object	newInstance() Instantiates a new support file object in memory.
boolean	releaseInstance(java.lang.Object supportFile) Releases instance of support file object from memory.
void	setDefaultOutputDirectory(java.lang.String defaultOutputDirectory) Set the default output directory where support file is to be retrieved

Methods inherited from class java.lang.Object

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

Constructor Detail

SupportFileFactory

protected SupportFileFactory()

Method Detail

getFactory

public static SupportFileFactory getFactory()

Returns the support file factory.

newInstance

public java.lang.Object newInstance()

Instantiates a new support file object in memory.

Specified by:

newInstance in interface IARObjectFactory

releaseInstance

public boolean releaseInstance(java.lang.Object supportFile)

Releases instance of support file object from memory.

Specified by:

releaseInstance in interface IARObjectFactory

findByKey

public static SupportFile findByKey(ARServerUser context,
                                    SupportFileKey key,
                                    SupportFileCriteria criteria)
                             throws ARException

Returns detailed information about the SupportFile object specified by SupportFileCriteria and SupportFileKey.

Parameters:

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

key - A SupportFileKey object that uniquely identifies the support file on the server.

criteria - A SupportFileCriteria object containing the name of the SupportFile and the information to retrieve

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if object information is not returned

find

public static SupportFileKey[] find(ARServerUser context,
                                    SupportFileListCriteria criteria)
                             throws ARException

Returns a list of SupportFileKey objects that contain the details of the support files specified by SupportFileListCriteria. Each support file key object represents one support file.

Parameters:

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

criteria - A SupportFileListCriteria object

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if list is not returned

getDefaultOutputDirectory

public java.lang.String getDefaultOutputDirectory()

Returns the default output directory where support file is is to be retrieved.

setDefaultOutputDirectory

public void setDefaultOutputDirectory(java.lang.String defaultOutputDirectory)

Set the default output directory where support file is to be retrieved

findObjects

public static SupportFile[] findObjects(ARServerUser context,
                                        SupportFileListCriteria listcriteria,
                                        SupportFileCriteria criteria)
                                 throws ARException

Returns a list of SupportFile objects that matches the search criteria given in the SupportFileListCriteria. The information retrieved for each of the support files depends on the SupportFileCriteria.

Parameters:

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

listcriteria - A SupportFileListCriteria object

criteria - A SupportFileCriteria object

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if list is not returned