com.bmc.arsys.api

Class SupportFileKey

java.lang.Object

com.bmc.arsys.api.SupportFileKey

All Implemented Interfaces:

Serializable, Cloneable

public class SupportFileKey
extends Object
implements Cloneable, Serializable

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SupportFileKey() constructor
SupportFileKey(int fileType, String name, int fieldId, int fileId)

Method Summary

Modifier and Type	Method and Description
Object	clone() Clone implementation that returns an Object with data cloned from self
boolean	equals(Object obj)
int	getFieldId() Returns the ID of the field or VUI, if the object is a form.
int	getFileId() Returns the unique identifier of the file within its object.
int	getFileType() Returns the type of file.
String	getName() Returns name of the object the file is associated with, usually a form.
int	hashCode()
void	setFileId(int fileId) Sets a unique identifier to the file within the form.
void	setFileType(int fileType) Sets the type of file.
void	setName(String name) Sets name of the object the file is associated with, usually a form.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SupportFileKey

public SupportFileKey()

constructor

SupportFileKey

public SupportFileKey(int fileType,
                      String name,
                      int fieldId,
                      int fileId)

Method Detail

getFileType

public int 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(int 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 String getName()

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

setName

public void setName(String name)

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

getFieldId

public int getFieldId()

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

getFileId

public int getFileId()

Returns the unique identifier of the file within its object.

setFileId

public void setFileId(int fileId)

Sets a unique identifier to the file within the form.

clone

public Object clone()
             throws CloneNotSupportedException

Clone implementation that returns an Object with data cloned from self

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

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