public class SupportFileKey extends Object implements Cloneable, Serializable
SupportFileKey
class
provides a unique identifier for support file objects.Constructor and Description |
---|
SupportFileKey()
constructor
|
SupportFileKey(int fileType,
String name,
int fieldId,
int fileId) |
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() |
public SupportFileKey()
public SupportFileKey(int fileType, String name, int fieldId, int fileId)
public int getFileType()
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.public void setFileType(int fileType)
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.public String getName()
public void setName(String name)
public int getFieldId()
public int getFileId()
public void setFileId(int fileId)
public Object clone() throws CloneNotSupportedException
clone
in class Object
CloneNotSupportedException
? Copyright 2013 BMC Software, Inc.