com.bmc.arsys.api
Class AuditInfo

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

All Implemented Interfaces:

Serializable, Cloneable

public class AuditInfo
extends Object
implements Cloneable, Serializable

The AuditInfo class and methods are used to represent the properties of AuditInfo objects.

Note: All the constants used in the AuditInfo class are found in the Constants class.

See Also:

Serialized Form

Constructor Summary

AuditInfo()
constructor

AuditInfo(boolean enable, int style, String form, QualifierInfo query, int auditMask)

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	getAuditForm() Gets the String for audit destination.
String	getAuditFrom() Gets the String for audit from.
int	getAuditMask()
int	getAuditStyle() Sets a bitmask for the audit styles.
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 audit is enabled or disabled.
void	setAuditForm(String form) Sets the String for audit destination.
void	setAuditMask(int auditMask)
void	setAuditStyle(int style)
void	setEnable(boolean enable) Sets flag to enable or disable this audit.
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

Constructor Detail

AuditInfo

public AuditInfo()

constructor

AuditInfo

public AuditInfo(boolean enable,
                 int style,
                 String form,
                 QualifierInfo query,
                 int auditMask)

Method Detail

isEnable

public boolean isEnable()

Returns flag whether this audit is enabled or disabled.

setEnable

public void setEnable(boolean enable)

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

getAuditStyle

public int getAuditStyle()

Sets a bitmask for the audit styles. A value of 0 disables the audit, A value of 1 sets audit to the copy style, A value of 2 sets audit to the log style

setAuditStyle

public void setAuditStyle(int style)

getAuditForm

public String getAuditForm()

Gets the String for audit destination.

setAuditForm

public void setAuditForm(String form)

Sets the String for audit destination.

Parameters:

form - the name of the form which is the audit destination

getAuditFrom

public String getAuditFrom()

Gets the String for audit from.

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.

setAuditMask

public void setAuditMask(int auditMask)

getAuditMask

public int getAuditMask()

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

Returns:

returns the hash code for this instance

toString

public String toString()

Returns a string description of the object.

Overrides:

toString in class Object