com.bmc.arsys.api
Class SupportFile

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

All Implemented Interfaces:

Serializable, Cloneable

public class SupportFile
extends Object
implements Cloneable, Serializable

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.

See Also:

Serialized Form

Constructor Summary

SupportFile()

SupportFile(int fileType, String name, int fieldId, int fileId, String fileNameWithPath, long lastUpdateTime)

Method Summary

static String	checkAndFillFilePath(ARServerUser ctx, int fileId, String filePath)
Object	clone() Clone implementation that returns an Object with data cloned from self
boolean	equals(Object obj)
void	fromVariant(Object[] rawData, ARServerUser ctx) Reserved for internal use.
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.
int	hashCode()
void	setFilePath(String fileNameWithPath) Sets a path to the support file.
void	setKey(SupportFileKey key) Sets a unique identifier to the support file.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SupportFile

public SupportFile()

SupportFile

public SupportFile(int fileType,
                   String name,
                   int fieldId,
                   int fileId,
                   String fileNameWithPath,
                   long lastUpdateTime)

Method Detail

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 String getFilePath()

Returns the path to the support file.

setFilePath

public void setFilePath(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 Object clone()
             throws CloneNotSupportedException

Clone implementation that returns an Object with data cloned from self

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

fromVariant

public void fromVariant(Object[] rawData,
                        ARServerUser ctx)

Reserved for internal use.

Parameters:

rawData -

ctx -

checkAndFillFilePath

public static String checkAndFillFilePath(ARServerUser ctx,
                                          int fileId,
                                          String filePath)

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object