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

All Known Subinterfaces:

IAuditEventInfo

public interface IAuditEventInfoBase

This interface provides access to the collection object that contains auditing event information.

Since:

4.0

Field Summary

static java.lang.String	KIND The Kind used to query for AuditEventInfo2 objects.
static java.lang.String	PROGID The ProgID used to query for AuditEventInfo2 objects.

Method Summary

IAuditCategories	getAuditCategories() Returns the collection of categories associated with auditing events.
IAuditConnectionInfo	getAuditConnectionInfo() Returns the auditing database connection object
IAuditDetails	getAuditDetails() Returns the collection of details associated with auditing events.
IAuditEvents	getAuditEvents() Returns the audit events collection.
IAuditLevels	getAuditLevels() Returns the collection of levels associated with auditing events.
int	getCurrentAuditLevel() Returns the auditing event level in use by the system.
int	getDeleteAfterNDays() Returns the number of days to keep logged auditing event entries for.
java.util.Set	getEnabledDetailTypeIDs() Returns the set of auditing event detail IDs enabled on the system.
java.util.Set	getEnabledEventTypeIDs() Returns the set of auditing event IDs enabled on the system.
java.util.List	getPreviousEnabledCustomAuditEvents() If the auditing level is changed, and the previous level was CUSTOM, this will return the list of auditing event IDs that were last enabled.
void	setCurrentAuditLevel(int auditLevel) Sets the current auditing event level.
void	setDeleteAfterNDays(int deleteAfterNDays) Set the number of days to keep stored auditing events for.

Field Detail

KIND

static final java.lang.String KIND

The Kind used to query for AuditEventInfo2 objects.

See Also:

Constant Field Values

PROGID

static final java.lang.String PROGID

The ProgID used to query for AuditEventInfo2 objects.

See Also:

Constant Field Values

Method Detail

getAuditEvents

IAuditEvents getAuditEvents()
                            throws SDKException

Returns the audit events collection.

Returns:

An IAuditEvents object containing auditing event information.

Throws:

SDKException - This is thrown if SI_AUDIT_EVENTS is not properly queried for.

getAuditConnectionInfo

IAuditConnectionInfo getAuditConnectionInfo()

Returns the auditing database connection object

Returns:

An IAuditConnectionInfo object containing auditing database connection information.

getAuditDetails

IAuditDetails getAuditDetails()
                              throws SDKException

Returns the collection of details associated with auditing events. These details determine what information is captured when events are triggered.

Returns:

A IAuditDetails containing the details for the audit events.

Throws:

SDKException - This is thrown if SI_AUDIT_EVENT_DETAILS is not properly queried for.

getEnabledEventTypeIDs

java.util.Set getEnabledEventTypeIDs()

Returns the set of auditing event IDs enabled on the system. To change the enabled events, retrieve this object and modify it, then commit the IInfoObjects object to the system.

Returns:

The set of auditing event IDs enabled on the system. Each element is of type Integer

getEnabledDetailTypeIDs

java.util.Set getEnabledDetailTypeIDs()
                                      throws SDKException

Returns the set of auditing event detail IDs enabled on the system. To change the enabled details, retrieve this object and modify it, then commit the IInfoObjects object to the system.

Returns:

The set of auditing event detail IDs enabled on the system. Each element is of type Integer

Throws:

SDKException - when SI_AUDIT_EVENT_DETAILS is not queried

getAuditLevels

IAuditLevels getAuditLevels()
                            throws SDKException

Returns the collection of levels associated with auditing events.

Returns:

A IAuditLevels object containing the levels for the audit events.

Throws:

SDKException - This is thrown if SI_AUDIT_LEVELS is not properly queried for.

getAuditCategories

IAuditCategories getAuditCategories()
                                    throws SDKException

Returns the collection of categories associated with auditing events.

Returns:

A IAuditCategories object containing the categories for the audit events.

Throws:

SDKException - This is thrown if SI_AUDIT_CATEGORIES is not properly queried for.

setCurrentAuditLevel

void setCurrentAuditLevel(int auditLevel)
                          throws SDKException

Sets the current auditing event level.

Parameters:

id - The ID of the auditing event level, or an int constant from the AuditEventLevel interface.

Throws:

SDKException - This is thrown if the auditLevel parameter is not a valid auditing event level ID.

getCurrentAuditLevel

int getCurrentAuditLevel()

Returns the auditing event level in use by the system.

Returns:

The auditing level currently set

setDeleteAfterNDays

void setDeleteAfterNDays(int deleteAfterNDays)
                         throws SDKException

Set the number of days to keep stored auditing events for. An error is thrown if the value is less than 1.

Parameters:

deleteAfterNDays - The number of days to keep auditing events for. After the set number of days have elapsed, the entries are deleted from the database and may be unrecoverable. It must be a value greater than or equal to 1 and less than or equal to 109200.

Throws:

SDKException - This is thrown if the deleteAfterNDays parameter is less than 1.

getDeleteAfterNDays

int getDeleteAfterNDays()

Returns the number of days to keep logged auditing event entries for. The default value is 36500.

Returns:

The number of days to delete logged event entries after.

getPreviousEnabledCustomAuditEvents

java.util.List getPreviousEnabledCustomAuditEvents()
                                                   throws SDKException

If the auditing level is changed, and the previous level was CUSTOM, this will return the list of auditing event IDs that were last enabled. This list will not be altered until the auditing level is changed from CUSTOM a subsequent time.

Returns:

A list containing the IDs of auditing events which were enabled when the system was last set to the CUSTOM auditing event level.

Throws:

SDKException - This is thrown if the SI_PREVIOUS_ENABLED_AUDIT_EVENTS object is empty. The most likely cause for this is that the changes to auditing levels have not been sufficient to warrant the population of this list.