com.businessobjects.sdk.plugin.desktop.auditeventinfo2
Interface IAuditEvent

All Superinterfaces:

IIdDescriptionPair, IIdMLDescription

public interface IAuditEvent
extends IIdMLDescription

This interface provides information about an auditing event.

Since:

4.0

Method Summary

int	getAuditCategory() Returns the auditing category this audit event belongs to.
int	getAuditLevel() Returns the auditing level that this audit event belongs to.
boolean	isEnabled() Returns true if collection of the auditing event is enabled, and false otherwise.
boolean	isMandatory(int detailId) Returns true if collecting the auditing event detail is mandatory for this auditing event.
boolean	isNeeded(int detailId) Returns true if collecting the auditing event detail is required by this event.
boolean	isSupported(int detailId) Returns true if collection of the auditing event detail may be set for this auditing event.

Methods inherited from interface com.businessobjects.sdk.plugin.desktop.common.IIdMLDescription

getDescription

Methods inherited from interface com.businessobjects.sdk.plugin.desktop.common.IIdDescriptionPair

getDescription, getID

Method Detail

isEnabled

boolean isEnabled()

Returns true if collection of the auditing event is enabled, and false otherwise.

Returns:

The status of the enabled flag for this auditing event

isNeeded

boolean isNeeded(int detailId)

Returns true if collecting the auditing event detail is required by this event. The purpose of this is to allow auditing event details to be disabled when it is found that collecting the detail is expensive. This returns true when the auditing event detail is both enabled and the mandatory flag also returns true.

Parameters:

detailId - The ID of the auditing event detail you wish to query for

Returns:

The needed flag status of the requested auditing event detail

isSupported

boolean isSupported(int detailId)

Returns true if collection of the auditing event detail may be set for this auditing event. Each event lists the details that are supported, and this is not configurable. The flag's status is true if the auditing event detail ID is found in the SI_SUPPORTED_AUDIT_DETAILS list in the entry of the SI_AUDIT_EVENTS item that defines this event.

Parameters:

detailId - The ID of the auditing event detail you wish to query for

Returns:

The supported flag status of the requested auditing event detail

isMandatory

boolean isMandatory(int detailId)

Returns true if collecting the auditing event detail is mandatory for this auditing event. Each event lists the details that are supported, and this is not configurable. The flag's status is true if the auditing event detail ID is found in the SI_MANDATORY_AUDIT_DETAILS list in the entry of the SI_AUDIT_EVENTS item that defines this event.

Parameters:

detailId - The ID of the auditing event detail you wish to query for

Returns:

The mandatory flag status of the requested auditing event detail

getAuditLevel

int getAuditLevel()

Returns the auditing level that this audit event belongs to.

Returns:

The auditing level that this audit event belongs to

getAuditCategory

int getAuditCategory()

Returns the auditing category this audit event belongs to.

Returns:

The auditing category this audit event belongs to