com.remedy.arsys.api
Class SupportFile

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

All Implemented Interfaces:

java.lang.Cloneable, IARPersistentObject

public class SupportFile

extends java.lang.Object

implements IARPersistentObject, java.lang.Cloneable

The SupportFile class and methods is used to represent the properties of a support file. A support file is a file that clients can retrieve by using the AR System. Such files are commonly used for reports (to store them separately from the active link that calls them, preventing large downloads of unneeded information). Each support file is associated with a server object. The SupportFile class contains the methods to store or retrieve any support file to/from the server.

Method Summary

void	activate() AR System reserved method.
void	clear() Clears all of the references to member objects.
java.lang.Object	clone() Clone implementation that returns an Object with data cloned from self
void	create() Creates a new support file with the indicated name on the specified server.
ARServerUser	getContext()
java.lang.String	getFilePath() Returns the path to the support file.
SupportFileKey	getKey() Returns the unique identifier for the support file.
Timestamp	getLastUpdateTime() Returns time stamp that limits the IDs retrieved to those modified after the specified time.
void	load() Populates support file with information from the AR System server.
void	load(SupportFileCriteria criteria) Populates support file with information specified by SupportFileCriteria from the AR System server.
void	passivate() AR System reserved method.
void	remove() Deletes a new support file with the indicated name on the specified server and deletes any references to the support file from other containers.
void	setContext(ARServerUser ctx) Associates ARServerUser information with this AR System server object.
void	setFilePath(java.lang.String fileNameWithPath) Sets a path to the support file.
void	setKey(SupportFileKey key) Sets a unique identifier to the support file.
void	store() Saves the changes made to this object.
void	store(SupportFileCriteria criteria) Updates this support file on the database
void	unsetContext() Removes the association to a specific user context.

Methods inherited from class java.lang.Object

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

Method Detail

getContext

public ARServerUser getContext()

setContext

public void setContext(ARServerUser ctx)

Description copied from interface: IARPersistentObject

Associates ARServerUser information with this AR System server object.

Specified by:

setContext in interface IARPersistentObject

unsetContext

public void unsetContext()

Description copied from interface: IARPersistentObject

Removes the association to a specific user context. This is equal to setContext(null).

Specified by:

unsetContext in interface IARPersistentObject

clear

public void clear()

Description copied from interface: IARPersistentObject

Clears all of the references to member objects.

Specified by:

clear in interface IARPersistentObject

create

public void create()
            throws ARException

Creates a new support file with the indicated name on the specified server. This operation can be performed by users with AR System administrator privileges only.

Specified by:

create in interface IARPersistentObject

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if support file is not created

remove

public void remove()
            throws ARException

Deletes a new support file with the indicated name on the specified server and deletes any references to the support file from other containers. Objects referenced by the support file are not deleted. This operation can be performed by users with AR System administrator privileges only.

Specified by:

remove in interface IARPersistentObject

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if support file is not deleted

load

public void load()
          throws ARException

Populates support file with information from the AR System server.

Specified by:

load in interface IARPersistentObject

Throws:

ARException - if support file is not loaded

load

public void load(SupportFileCriteria criteria)
          throws ARException

Populates support file with information specified by SupportFileCriteria from the AR System server.

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if support file is not loaded

store

public void store(SupportFileCriteria criteria)
           throws ARException

Updates this support file on the database

Throws:

java.lang.NullPointerException - if invalid ARServerUser object

ARException - if support file is not saved

store

public void store()
           throws ARException

Saves the changes made to this object.

Specified by:

store in interface IARPersistentObject

Throws:

ARException - if support file is not saved

activate

public void activate()

Description copied from interface: IARPersistentObject

AR System reserved method.

Specified by:

activate in interface IARPersistentObject

passivate

public void passivate()

Description copied from interface: IARPersistentObject

AR System reserved method.

Specified by:

passivate in interface IARPersistentObject

getKey

public SupportFileKey getKey()

Returns the unique identifier for the support file.

setKey

public void setKey(SupportFileKey key)

Sets a unique identifier to the support file.

getFilePath

public java.lang.String getFilePath()

Returns the path to the support file.

setFilePath

public void setFilePath(java.lang.String fileNameWithPath)

Sets a path to the support file.

getLastUpdateTime

public Timestamp getLastUpdateTime()

Returns time stamp that limits the IDs retrieved to those modified after the specified time. Specify 0 for this parameter if you want to retrieve all IDs.

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Clone implementation that returns an Object with data cloned from self

Throws:

java.lang.CloneNotSupportedException