public class ArchiveInfo extends Object implements Cloneable, Serializable
ArchiveInfo
class and methods are used to represent the properties of ArchiveInfo objects.
Note:
All the constants used in the ArchiveInfo
class are found in the
Constants
class.
Modifier and Type | Field and Description |
---|---|
static int |
AR_ARCHIVE_DELETE
the archive type is "delete from main form"
|
static int |
AR_ARCHIVE_FILE_ARX
the archive type is "archive to file in ARX format"
|
static int |
AR_ARCHIVE_FILE_XML
the archive type is "archive to file in XML format"
|
static int |
AR_ARCHIVE_FORM
the archive type is "copy to form"
|
static int |
AR_ARCHIVE_NO_ATTACHMENTS
the archive type is "do not archive attachments"
|
static int |
AR_ARCHIVE_NO_DIARY
the archive type is "do not archive diary fields"
|
static int |
AR_ARCHIVE_NONE
the archive type is "no archive"
|
Constructor and Description |
---|
ArchiveInfo()
constructor
|
ArchiveInfo(boolean enable,
int archiveType,
String archiveDest,
EscalationTime archiveTmInfo,
QualifierInfo query) |
ArchiveInfo(boolean enable,
int archiveType,
String archiveDest,
EscalationTime archiveTmInfo,
QualifierInfo query,
String archiveFrom) |
ArchiveInfo(boolean enable,
int archiveType,
String archiveDest,
EscalationTime archiveTmInfo,
QualifierInfo query,
String archiveFrom,
int ageQualifierInDays,
int ageQualifierFieldId,
boolean appearInArchiveInfo,
String description) |
Modifier and Type | Method and Description |
---|---|
Object |
clone()
Clone implementation that returns an Object with data cloned from self.
|
boolean |
equals(Object obj)
Use this method for checking equality between the current object and the
provided one.
|
int |
getAgeQualifierFieldId() |
int |
getAgeQualifierInDays() |
String |
getArchiveDest()
Gets/Sets the String for archive destination.
|
String |
getArchiveFrom()
Gets the String for archive from.
|
EscalationTime |
getArchiveTmInfo()
Returns the time specification for evaluating the archive condition.
|
int |
getArchiveType()
Gets/Sets a bitmask for the archive types.
|
String |
getDescription() |
QualifierInfo |
getQualifier()
Returns the qualification that determines which set of If/Else actions should be executed.
|
int |
hashCode()
Returns the hash code value for this instance of the current class.
|
boolean |
isAppearInArchivePolicy() |
boolean |
isEnable()
Returns flag whether this archive is enabled or disabled.
|
void |
setAgeQualifierFieldId(int ageQualifierFieldId) |
void |
setAgeQualifierInDays(int ageQualifierInDays)
Sets the age qualification for the archive operation
|
void |
setAppearInArchivePolicy(boolean enable) |
void |
setArchiveDest(String archiveDest) |
void |
setArchiveFrom(String archiveFrom) |
void |
setArchiveTmInfo(EscalationTime archiveTmInfo)
Sets the time specification for evaluating the archive condition.
|
void |
setArchiveType(int archiveType) |
void |
setDescription(String description) |
void |
setEnable(boolean enable)
Sets flag to enable or disable this archive.
|
void |
setQualifier(QualifierInfo query)
Sets the qualification that determines what data to be archived.
|
String |
toString()
Returns a string description of the object.
|
public static int AR_ARCHIVE_NONE
public static int AR_ARCHIVE_FORM
public static int AR_ARCHIVE_DELETE
public static int AR_ARCHIVE_FILE_XML
public static int AR_ARCHIVE_FILE_ARX
public static int AR_ARCHIVE_NO_ATTACHMENTS
public static int AR_ARCHIVE_NO_DIARY
public ArchiveInfo()
public ArchiveInfo(boolean enable, int archiveType, String archiveDest, EscalationTime archiveTmInfo, QualifierInfo query)
public ArchiveInfo(boolean enable, int archiveType, String archiveDest, EscalationTime archiveTmInfo, QualifierInfo query, String archiveFrom)
public ArchiveInfo(boolean enable, int archiveType, String archiveDest, EscalationTime archiveTmInfo, QualifierInfo query, String archiveFrom, int ageQualifierInDays, int ageQualifierFieldId, boolean appearInArchiveInfo, String description)
public boolean isEnable()
public void setEnable(boolean enable)
public int getArchiveType()
public void setArchiveType(int archiveType)
public String getArchiveDest()
public void setArchiveDest(String archiveDest)
public String getArchiveFrom()
public void setArchiveFrom(String archiveFrom)
public EscalationTime getArchiveTmInfo()
public void setArchiveTmInfo(EscalationTime archiveTmInfo)
public QualifierInfo getQualifier()
public void setQualifier(QualifierInfo query)
NULL
or assign an
operation value of 0 (Constants.AR_COND_OP_NONE
) if the archive has no qualification.public int getAgeQualifierInDays()
public void setAgeQualifierInDays(int ageQualifierInDays)
ageQualifierForModifiedTime
- public int getAgeQualifierFieldId()
public void setAgeQualifierFieldId(int ageQualifierFieldId)
public void setAppearInArchivePolicy(boolean enable)
public boolean isAppearInArchivePolicy()
public String getDescription()
public void setDescription(String description)
public Object clone() throws CloneNotSupportedException
clone
in class Object
CloneNotSupportedException
public boolean equals(Object obj)
public int hashCode()
? Copyright 2013 BMC Software, Inc.