com.remedy.arsys.api
Class SupportFileKey

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

All Implemented Interfaces:

java.lang.Cloneable

public class SupportFileKey

extends java.lang.Object

implements java.lang.Cloneable

The SupportFileKey class provides a unique identifier for support file objects.

Constructor Summary

SupportFileKey()
constructor

SupportFileKey(long fileType, NameID name, InternalID fieldId, InternalID fileId)

Method Summary

java.lang.Object	clone() Clone implementation that returns an Object with data cloned from self
InternalID	getFieldId() Returns the ID of the field or VUI, if the object is a form.
long	getFileId() Returns the unique identifier of the file within its object.
long	getFileType() Returns the type of file.
NameID	getName() Returns name of the object the file is associated with, usually a form.
void	setFileId(long fileId) Sets a unique identifier to the file within the form.
void	setFileType(long fileType) Sets the type of file.
void	setName(NameID name) Sets name of the object the file is associated with, usually a form.

Methods inherited from class java.lang.Object

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

Constructor Detail

SupportFileKey

public SupportFileKey()

constructor

SupportFileKey

public SupportFileKey(long fileType,
                      NameID name,
                      InternalID fieldId,
                      InternalID fileId)

Method Detail

getFileType

public long getFileType()

Returns the type of file. 1 (Constants.AR_SUPPORT_FILE_EXTERNAL_REPORT) is an external report file. This is the only file type currently supported by the AR System. 0 (Constants.AR_SUPPORT_FILE_NONE) is no file type.

setFileType

public void setFileType(long fileType)

Sets the type of file. Specify 1 (Constants.AR_SUPPORT_FILE_EXTERNAL_REPORT) for an external report file. This is the only file type currently supported by the AR System. When you're using the SupportFileListCriteria class, if the fileType is (Constants.AR_SUPPORT_FILE_EXTERNAL_REPORT), the name is an active link, the field ID is ignored, and the index indicates a tag within a macro within that active link to which this support file is connected. Specify 0 (Constants.AR_SUPPORT_FILE_NONE) for no file type.

getName

public NameID getName()

Returns name of the object the file is associated with, usually a form.

setName

public void setName(NameID name)

Sets name of the object the file is associated with, usually a form.

getFieldId

public InternalID getFieldId()

Returns the ID of the field or VUI, if the object is a form.

getFileId

public long getFileId()

Returns the unique identifier of the file within its object.

setFileId

public void setFileId(long fileId)

Sets a unique identifier to the file within the form.

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