com.remedy.arsys.api
Class ArchiveInfo

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

All Implemented Interfaces:

java.lang.Cloneable

public class ArchiveInfo

extends java.lang.Object

implements java.lang.Cloneable

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.

Constructor Summary

ArchiveInfo()
constructor

ArchiveInfo(long enable, long archiveType, java.lang.String archiveDest, DayInfo archiveTmInfo, QualifierInfo query)

Method Summary

void	clear()
java.lang.Object	clone() Clone implementation that returns an Object with data cloned from self.
boolean	equals(java.lang.Object anObject) Use this method for checking equality.
java.lang.String	getArchiveDest() Gets/Sets the String for archive destination.
java.lang.String	getArchiveFrom() Gets the String for archive from.
DayInfo	getArchiveTmInfo() Returns the time specification for evaluating the archive condition.
long	getArchiveType() Sets a bitmask for the archive types.
long	getEnable() Returns flag whether this archive is enabled or disabled.
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.
void	setArchiveDest(java.lang.String archiveDest)
void	setArchiveTmInfo(DayInfo archiveTmInfo) Sets the time specification for evaluating the archive condition.
void	setArchiveType(long archiveType)
void	setContext(ARServerUser ctx)
void	setEnable(long enable) Sets flag to enable or disable this archive.
void	setQualifier(QualifierInfo query) Sets the qualification that determines what data to be archived.
void	unsetContext()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ArchiveInfo

public ArchiveInfo()

constructor

ArchiveInfo

public ArchiveInfo(long enable,
                   long archiveType,
                   java.lang.String archiveDest,
                   DayInfo archiveTmInfo,
                   QualifierInfo query)

Method Detail

setContext

public void setContext(ARServerUser ctx)

unsetContext

public void unsetContext()

clear

public void clear()

getEnable

public long getEnable()

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(long 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 long getArchiveType()

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(long archiveType)

getArchiveDest

public java.lang.String getArchiveDest()

Gets/Sets the String for archive destination.

setArchiveDest

public void setArchiveDest(java.lang.String archiveDest)

getArchiveFrom

public java.lang.String getArchiveFrom()

Gets the String for archive from.

getArchiveTmInfo

public DayInfo getArchiveTmInfo()

Returns the time specification for evaluating the archive condition.

setArchiveTmInfo

public void setArchiveTmInfo(DayInfo 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 java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

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

Throws:

java.lang.CloneNotSupportedException

equals

public boolean equals(java.lang.Object anObject)

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

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.