com.bmc.arsys.api
Class ArchiveInfo

java.lang.Object
  com.bmc.arsys.api.ArchiveInfo

All Implemented Interfaces:

Serializable, Cloneable

public class ArchiveInfo
extends Object
implements Cloneable, Serializable

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

See Also:

Serialized Form

Field Summary

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 Summary

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)

Method Summary

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.
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.
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	isEnable() Returns flag whether this archive is enabled or disabled.
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	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.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

AR_ARCHIVE_NONE

public static int AR_ARCHIVE_NONE

the archive type is "no archive"

AR_ARCHIVE_FORM

public static int AR_ARCHIVE_FORM

the archive type is "copy to form"

AR_ARCHIVE_DELETE

public static int AR_ARCHIVE_DELETE

the archive type is "delete from main form"

AR_ARCHIVE_FILE_XML

public static int AR_ARCHIVE_FILE_XML

the archive type is "archive to file in XML format"

AR_ARCHIVE_FILE_ARX

public static int AR_ARCHIVE_FILE_ARX

the archive type is "archive to file in ARX format"

AR_ARCHIVE_NO_ATTACHMENTS

public static int AR_ARCHIVE_NO_ATTACHMENTS

the archive type is "do not archive attachments"

AR_ARCHIVE_NO_DIARY

public static int AR_ARCHIVE_NO_DIARY

the archive type is "do not archive diary fields"

Constructor Detail

ArchiveInfo

public ArchiveInfo()

constructor

ArchiveInfo

public ArchiveInfo(boolean enable,
                   int archiveType,
                   String archiveDest,
                   EscalationTime archiveTmInfo,
                   QualifierInfo query)

ArchiveInfo

public ArchiveInfo(boolean enable,
                   int archiveType,
                   String archiveDest,
                   EscalationTime archiveTmInfo,
                   QualifierInfo query,
                   String archiveFrom)

Method Detail

isEnable

public boolean isEnable()

Returns flag whether this archive is enabled or disabled. A value of 0 -- archive is disabled. A value of 1 -- archive is enabled.

setEnable

public void setEnable(boolean enable)

Sets flag to enable or disable this archive. A value of 0 disables the archive, A value of 1 enables the archive, causing its archive to resume

getArchiveType

public int getArchiveType()

Gets/Sets a bitmask for the archive types. A value of 0 disables the archive, A value of 1 enables the archive, causing its archive to resume

setArchiveType

public void setArchiveType(int archiveType)

getArchiveDest

public String getArchiveDest()

Gets/Sets the String for archive destination.

setArchiveDest

public void setArchiveDest(String archiveDest)

getArchiveFrom

public String getArchiveFrom()

Gets the String for archive from.

setArchiveFrom

public void setArchiveFrom(String archiveFrom)

getArchiveTmInfo

public EscalationTime getArchiveTmInfo()

Returns the time specification for evaluating the archive condition.

setArchiveTmInfo

public void setArchiveTmInfo(EscalationTime archiveTmInfo)

Sets the time specification for evaluating the archive condition. This parameter can take one form: a bitmask that defines a particular day (by month or week) and time (hour and minute) for the server to check the condition.

getQualifier

public QualifierInfo getQualifier()

Returns the qualification that determines which set of If/Else actions should be executed.

setQualifier

public void setQualifier(QualifierInfo query)

Sets the qualification that determines what data to be archived. Specify NULL or assign an operation value of 0 (Constants.AR_COND_OP_NONE) if the archive has no qualification.

clone

public Object clone()
             throws CloneNotSupportedException

Clone implementation that returns an Object with data cloned from self.

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

equals

public boolean equals(Object obj)

Use this method for checking equality between the current object and the provided one. The result is true only if the argument is not null, is of the same type and represents the same content.

Overrides:

equals in class Object

Parameters:

obj - the object that we are comparing to

Returns:

returns a boolean that tells if the two objects equal

hashCode

public int hashCode()

Returns the hash code value for this instance of the current class. This method is supported as required by the general contract of Object.hashCode, for the benefit of hash tables such as those provided by java.util.Hashtable.

Overrides:

hashCode in class Object

toString

public String toString()

Returns a string description of the object.

Overrides:

toString in class Object