oracle.ifs.common

Class AuditTypeEntryValue

java.lang.Object

oracle.ifs.common.AuditTypeEntryValue

All Implemented Interfaces:

Serializable, Comparable

public final class AuditTypeEntryValue
extends Object
implements Serializable, Comparable

An AuditTypeEntryValue is a light-weight representation of an Audit operation type, and the indication as to whether successful and/or failed operations should be audited for that operation type.

Author:

Dave Long

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	AUDIT_SUCCESS_MODE_FAILURE_ONLY Constant used for the OPERATIONSUCCESSMODE attribute, indicating that only failed operations will be audited.
static int	AUDIT_SUCCESS_MODE_NONE Constant used for the OPERATIONSUCCESSMODE attribute, indicating that neither successful nor failed operations will be audited.
static int	AUDIT_SUCCESS_MODE_SUCCESS_ONLY Constant used for the OPERATIONSUCCESSMODE attribute, indicating that only successful operations will be audited.
static int	AUDIT_SUCCESS_MODE_SUCCESS_OR_FAILURE Constant used for the OPERATIONSUCCESSMODE attribute, indicating that both successful and failed operations will be audited.

Constructor Summary

Constructors

Constructor and Description
AuditTypeEntryValue(int opType, String opTypeKey, int mode) Constructs an AuditTypeEntryValue.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Object obj) Determines the order of this result with respect to another.
int	getOperationSuccessMode() Returns the numeric value that describes whether successful and/or failed operations should be audited.
int	getOperationType() Gets the operation type.
String	getOperationTypeKey() Gets the operation type key.
boolean	isOperationIncluded(boolean wasSuccessful) Gets whether an operation with the specified success status should be audited.

Methods inherited from class java.lang.Object

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

Field Detail

AUDIT_SUCCESS_MODE_NONE

public static final int AUDIT_SUCCESS_MODE_NONE

Constant used for the OPERATIONSUCCESSMODE attribute, indicating that neither successful nor failed operations will be audited.

Value: 1

See Also:

Constant Field Values

AUDIT_SUCCESS_MODE_SUCCESS_ONLY

public static final int AUDIT_SUCCESS_MODE_SUCCESS_ONLY

Constant used for the OPERATIONSUCCESSMODE attribute, indicating that only successful operations will be audited.

Value: 2

See Also:

Constant Field Values

AUDIT_SUCCESS_MODE_FAILURE_ONLY

public static final int AUDIT_SUCCESS_MODE_FAILURE_ONLY

Constant used for the OPERATIONSUCCESSMODE attribute, indicating that only failed operations will be audited.

Value: 3

See Also:

Constant Field Values

AUDIT_SUCCESS_MODE_SUCCESS_OR_FAILURE

public static final int AUDIT_SUCCESS_MODE_SUCCESS_OR_FAILURE

Constant used for the OPERATIONSUCCESSMODE attribute, indicating that both successful and failed operations will be audited.

Value: 4

See Also:

Constant Field Values

Constructor Detail

AuditTypeEntryValue

public AuditTypeEntryValue(int opType,
                           String opTypeKey,
                           int mode)

Constructs an AuditTypeEntryValue.

Parameters:

opType - the operation type

opTypeKey - the equivalent operation type key

mode - the success/failure mode

Method Detail

getOperationType

public int getOperationType()

Gets the operation type.

Returns:

the operation type

getOperationTypeKey

public String getOperationTypeKey()

Gets the operation type key.

Returns:

the operation type key

isOperationIncluded

public boolean isOperationIncluded(boolean wasSuccessful)

Gets whether an operation with the specified success status should be audited.

Returns:

whether successful operations should be audited

getOperationSuccessMode

public int getOperationSuccessMode()

Returns the numeric value that describes whether successful and/or failed operations should be audited.

Will be one of the following constants:

• AUDIT_SUCCESS_MODE_NONE
• AUDIT_SUCCESS_MODE_SUCCESS_ONLY
• AUDIT_SUCCESS_MODE_FAILURE_ONLY
• AUDIT_SUCCESS_MODE_SUCCESS_OR_FAILURE

Returns:

the operation success mode

compareTo

public int compareTo(Object obj)
              throws ClassCastException

Determines the order of this result with respect to another.

Note: this class has a natural ordering that is inconsistent with equals.

Specified by:

compareTo in interface Comparable

Parameters:

obj - the AuditTypeEntryValue to compare

Returns:

a positive integer if the target precedes the object specified; a negative integer if the target follows the object specified

Throws:

ClassCastException - if the object specified is not an AuditTypeEntryValue

(Unpublished)