com.remedy.arsys.api
Class SupportFileListCriteria

java.lang.Object
  |
  +--com.remedy.arsys.api.ListCriteriaBase
        |
        +--com.remedy.arsys.api.SupportFileListCriteria

public class SupportFileListCriteria

extends com.remedy.arsys.api.ListCriteriaBase

The SupportFileListCriteria class is used to define the search criteria for retrieving the support files from the server.

Constructor Summary

SupportFileListCriteria()
constructor

SupportFileListCriteria(long fileType, java.lang.String name, long fieldId, long changedSince)

Method Summary

InternalID	getFieldId() Returns the ID of the field or VUI, if the object is a form.
long	getFileType() Returns the type of file.
NameID	getName() Returns the name of the object the file is associated with, usually a form.
void	setFieldId(InternalID fieldId) Sets the ID of the field or VUI, if the object is a form.
void	setFileType(long fileType) Sets the type of file.
void	setName(NameID name) Sets the name of the object the file is associated with, usually a form.

Methods inherited from class com.remedy.arsys.api.ListCriteriaBase

clone, getModifiedAfter, setModifiedAfter

Methods inherited from class java.lang.Object

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

Constructor Detail

SupportFileListCriteria

public SupportFileListCriteria()

constructor

SupportFileListCriteria

public SupportFileListCriteria(long fileType,
                               java.lang.String name,
                               long fieldId,
                               long changedSince)

Method Detail

getFileType

public long getFileType()

Returns 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.

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 the name of the object the file is associated with, usually a form.

setName

public void setName(NameID name)

Sets the 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.

setFieldId

public void setFieldId(InternalID fieldId)

Sets the ID of the field or VUI, if the object is a form. If the object is not a form, set this parameter to 0.