com.businessobjects.sdk.plugin.admin.auditadmin
Interface IWebiServerAuditAdmin

Deprecated. As of version 12.0.

public interface IWebiServerAuditAdmin

The IWebiServerAuditAdmin interface provides the Central Management Server (CMS) with auditing information regarding the Web Intelligence Report Server. Use this interface to set which events you would like to audit. Furthermore, when a new IWebiServerAuditAdmin object is created, it supplies its own functionality and inherits methods that are associated with the IAuditAdmin interface.

Method Summary

boolean	getDocumentEdited() Deprecated. As of version 12.0.
boolean	getDocumentRead() Deprecated. As of version 12.0.
boolean	getDocumentRefreshed() Deprecated. As of version 12.0.
boolean	getDocumentSavedToRepository() Deprecated. As of version 12.0.
boolean	getDrillOutOfScope() Deprecated. As of version 12.0.
boolean	getFormatAppliedToDocument() Deprecated. As of version 12.0.
boolean	getListOfUniversesRetrieved() Deprecated. As of version 12.0.
boolean	getListOfValuesAcccessed() Deprecated. As of version 12.0.
boolean	getPageAccessed() Deprecated. As of version 12.0.
boolean	getSQLGenerated() Deprecated. As of version 12.0.
boolean	getUniverseSelected() Deprecated. As of version 12.0.
void	setDocumentEdited(boolean enable) Deprecated. As of version 12.0.
void	setDocumentRead(boolean enable) Deprecated. As of version 12.0.
void	setDocumentRefreshed(boolean enable) Deprecated. As of version 12.0.
void	setDocumentSavedToRepository(boolean enable) Deprecated. As of version 12.0.
void	setDrillOutOfScope(boolean enable) Deprecated. As of version 12.0.
void	setFormatAppliedToDocument(boolean enable) Deprecated. As of version 12.0.
void	setListOfUniversesRetrieved(boolean enable) Deprecated. As of version 12.0.
void	setListOfValuesAcccessed(boolean enable) Deprecated. As of version 12.0.
void	setPageAccessed(boolean enable) Deprecated. As of version 12.0.
void	setSQLGenerated(boolean enable) Deprecated. As of version 12.0.
void	setUniverseSelected(boolean enable) Deprecated. As of version 12.0.

Method Detail

getListOfUniversesRetrieved

boolean getListOfUniversesRetrieved()
                                    throws SDKException

Deprecated. As of version 12.0.

Returns true if the Web Intelligence Report Server audits when a user retrieves or refreshes the universe list from a Web Intelligence document, and false otherwise.

Returns:

A boolean that indicates whether the event is audited.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setListOfUniversesRetrieved

void setListOfUniversesRetrieved(boolean enable)
                                 throws SDKException

Deprecated. As of version 12.0.

Sets whether the Web Intelligence Report Server audits when a user retrieves or refreshes a universe list from a Web Intelligence document.

Parameters:

value - A boolean that indicates whether the event is audited.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getDocumentSavedToRepository

boolean getDocumentSavedToRepository()
                                     throws SDKException

Deprecated. As of version 12.0.

Returns true if the Web Intelligence Report Server audits when a user saves a Web Intelligence document to the repository, and false otherwise.

Returns:

A boolean that indicates whether the event is audited.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setDocumentSavedToRepository

void setDocumentSavedToRepository(boolean enable)
                                  throws SDKException

Deprecated. As of version 12.0.

Sets whether the Web Intelligence Report Server audits when a user saves a Web Intelligence document to the repository.

Parameters:

value - A boolean that indicates whether the event is audited.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getDocumentRead

boolean getDocumentRead()
                        throws SDKException

Deprecated. As of version 12.0.

Returns true if the Web Intelligence Report Server audits when a user opens a Web Intelligence document, and false otherwise.

Returns:

A boolean that indicates whether the event is audited.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setDocumentRead

void setDocumentRead(boolean enable)
                     throws SDKException

Deprecated. As of version 12.0.

Sets whether the Web Intelligence Report Server audits when a user opens a Web Intelligence document.

Parameters:

value - A boolean that indicates whether the event is audited.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getUniverseSelected

boolean getUniverseSelected()
                            throws SDKException

Deprecated. As of version 12.0.

Returns true if the Web Intelligence Report Server audits when a user selects a universe in a Web Intelligence document creation workflow, and false otherwise.

Returns:

A boolean that indicates whether the event is audited.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setUniverseSelected

void setUniverseSelected(boolean enable)
                         throws SDKException

Deprecated. As of version 12.0.

Sets whether the Web Intelligence Report Server audits when a user selects a universe in a Web Intelligence document creation workflow.

Parameters:

value - A boolean that indicates whether the event is audited.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getDocumentRefreshed

boolean getDocumentRefreshed()
                             throws SDKException

Deprecated. As of version 12.0.

Returns true if the Web Intelligence Report Server audits for the event in which a user refreshes a Web Intelligence document, and false otherwise.

Returns:

A boolean that indicates whether the event is audited.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setDocumentRefreshed

void setDocumentRefreshed(boolean enable)
                          throws SDKException

Deprecated. As of version 12.0.

Sets whether the Web Intelligence Report Server audits for the event in which a user refreshes a Web Intelligence document.

Parameters:

value - A boolean that indicates whether the event is audited.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getListOfValuesAcccessed

boolean getListOfValuesAcccessed()
                                 throws SDKException

Deprecated. As of version 12.0.

Returns true if the Web Intelligence Report Server audits when a user accesses or organizes a list of values through a prompt, and false otherwise.

Returns:

A boolean that indicates whether the event is audited.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setListOfValuesAcccessed

void setListOfValuesAcccessed(boolean enable)
                              throws SDKException

Deprecated. As of version 12.0.

Sets whether the Web Intelligence Report Server audits when a user accesses or organizes a list of values.

Parameters:

value - A boolean that indicates whether the event is audited.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getDocumentEdited

boolean getDocumentEdited()
                          throws SDKException

Deprecated. As of version 12.0.

Returns true if the Web Intelligence Report Server audits when a user edits a Web Intelligence document, and false otherwise.

Returns:

A boolean that indicates whether the event is audited.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setDocumentEdited

void setDocumentEdited(boolean enable)
                       throws SDKException

Deprecated. As of version 12.0.

Sets whether the Web Intelligence Report Server audits when a user edits a Web Intelligence document.

Parameters:

value - A boolean that indicates whether the event is audited.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getFormatAppliedToDocument

boolean getFormatAppliedToDocument()
                                   throws SDKException

Deprecated. As of version 12.0.

Returns true if the Web Intelligence Report Server audits when a user modifies the format of a Web Intelligence document, and false otherwise.

If this property is set to true, the following events are audited by the Web Intelligence Report Server:

• A user modifies any visual component of a Web Intelligence document; this includes a cell, a section, or the entire report.
• A user saves a Web Intelligence document to a different format, such as PDF (.pdf), or Microsoft Excel (.xls).

Returns:

A boolean that indicates whether the event is audited.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setFormatAppliedToDocument

void setFormatAppliedToDocument(boolean enable)
                                throws SDKException

Deprecated. As of version 12.0.

Sets whether the Web Intelligence Report Server audits when a user modifies the format of a Web Intelligence document.

Parameters:

value - A boolean that indicates whether the event is audited.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getPageAccessed

boolean getPageAccessed()
                        throws SDKException

Deprecated. As of version 12.0.

Returns true if the Web Intelligence Report Server audits when a user views one or more pages of a Web Intelligence document, and false otherwise.

Returns:

A boolean that indicates whether the event is audited.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setPageAccessed

void setPageAccessed(boolean enable)
                     throws SDKException

Deprecated. As of version 12.0.

Sets whether the Web Intelligence Report Server audits when a user views one or more pages of a Web Intelligence document.

Parameters:

value - A boolean that indicates whether the event is audited.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getSQLGenerated

boolean getSQLGenerated()
                        throws SDKException

Deprecated. As of version 12.0.

Returns true if the Web Intelligence Report Server audits when a user generates a SQL query, and false otherwise.

Returns:

A boolean that indicates whether the event is audited.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setSQLGenerated

void setSQLGenerated(boolean enable)
                     throws SDKException

Deprecated. As of version 12.0.

Sets whether the Web Intelligence Report Server audits when a user generates a SQL query.

Parameters:

value - A boolean that indicates whether the event is audited.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getDrillOutOfScope

boolean getDrillOutOfScope()
                           throws SDKException

Deprecated. As of version 12.0.

Returns true if the Web Intelligence Report Server audits when a user drills into data that is out of scope.

Drill out of scope indicates that a user has attempted to drill into data that is not included in the dataset.

Note: If you need to update your dataset, you will need to issue another SQL query that retrieves the correct information from the datasource.

Returns:

A boolean that indicates whether the event is audited.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setDrillOutOfScope

void setDrillOutOfScope(boolean enable)
                        throws SDKException

Deprecated. As of version 12.0.

Sets whether the Web Intelligence Report Server audits when a user drills into data that is out of scope.

Drill out of scope indicates that a user has attempted to drill into data that is not included in the dataset.

Note: If you need to update your dataset, you will need to issue another SQL query that retrieves the correct information from the datasource.

Parameters:

value - A boolean that indicates whether the event is audited.

Throws:

SDKException - This is thrown if the process is unsuccessful.