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


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()
           Returns true if the Web Intelligence Report Server audits when a user edits a Web Intelligence document, and false otherwise.
 boolean getDocumentRead()
           Returns true if the Web Intelligence Report Server audits when a user opens a Web Intelligence document, and false otherwise.
 boolean getDocumentRefreshed()
           Returns true if the Web Intelligence Report Server audits for the event in which a user refreshes a Web Intelligence document, and false otherwise.
 boolean getDocumentSavedToRepository()
           Returns true if the Web Intelligence Report Server audits when a user saves a Web Intelligence document to the repository, and false otherwise.
 boolean getDrillOutOfScope()
           Returns true if the Web Intelligence Report Server audits when a user drills into data that is out of scope.
 boolean getFormatAppliedToDocument()
           Returns true if the Web Intelligence Report Server audits when a user modifies the format of a Web Intelligence document, and false otherwise.
 boolean getListOfUniversesRetrieved()
           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.
 boolean getListOfValuesAcccessed()
           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.
 boolean getPageAccessed()
           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.
 boolean getSQLGenerated()
           Returns true if the Web Intelligence Report Server audits when a user generates a SQL query, and false otherwise.
 boolean getUniverseSelected()
           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.
 void setDocumentEdited(boolean enable)
           Sets whether the Web Intelligence Report Server audits when a user edits a Web Intelligence document.
 void setDocumentRead(boolean enable)
           Sets whether the Web Intelligence Report Server audits when a user opens a Web Intelligence document.
 void setDocumentRefreshed(boolean enable)
           Sets whether the Web Intelligence Report Server audits for the event in which a user refreshes a Web Intelligence document.
 void setDocumentSavedToRepository(boolean enable)
           Sets whether the Web Intelligence Report Server audits when a user saves a Web Intelligence document to the repository.
 void setDrillOutOfScope(boolean enable)
           Sets whether the Web Intelligence Report Server audits when a user drills into data that is out of scope.
 void setFormatAppliedToDocument(boolean enable)
           Sets whether the Web Intelligence Report Server audits when a user modifies the format of a Web Intelligence document.
 void setListOfUniversesRetrieved(boolean enable)
           Sets whether the Web Intelligence Report Server audits when a user retrieves or refreshes a universe list from a Web Intelligence document.
 void setListOfValuesAcccessed(boolean enable)
           Sets whether the Web Intelligence Report Server audits when a user accesses or organizes a list of values.
 void setPageAccessed(boolean enable)
           Sets whether the Web Intelligence Report Server audits when a user views one or more pages of a Web Intelligence document.
 void setSQLGenerated(boolean enable)
           Sets whether the Web Intelligence Report Server audits when a user generates a SQL query.
 void setUniverseSelected(boolean enable)
           Sets whether the Web Intelligence Report Server audits when a user selects a universe in a Web Intelligence document creation workflow.
 

Method Detail

getListOfUniversesRetrieved

public boolean getListOfUniversesRetrieved()
                                    throws SDKException

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

public void setListOfUniversesRetrieved(boolean enable)
                                 throws SDKException

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

Throws:
SDKException - This is thrown if the process is unsuccessful.

getDocumentSavedToRepository

public boolean getDocumentSavedToRepository()
                                     throws SDKException

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

public void setDocumentSavedToRepository(boolean enable)
                                  throws SDKException

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

Throws:
SDKException - This is thrown if the process is unsuccessful.

getDocumentRead

public boolean getDocumentRead()
                        throws SDKException

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

public void setDocumentRead(boolean enable)
                     throws SDKException

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

Throws:
SDKException - This is thrown if the process is unsuccessful.

getUniverseSelected

public boolean getUniverseSelected()
                            throws SDKException

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

public void setUniverseSelected(boolean enable)
                         throws SDKException

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

Throws:
SDKException - This is thrown if the process is unsuccessful.

getDocumentRefreshed

public boolean getDocumentRefreshed()
                             throws SDKException

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

public void setDocumentRefreshed(boolean enable)
                          throws SDKException

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

Throws:
SDKException - This is thrown if the process is unsuccessful.

getListOfValuesAcccessed

public boolean getListOfValuesAcccessed()
                                 throws SDKException

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

public void setListOfValuesAcccessed(boolean enable)
                              throws SDKException

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

Throws:
SDKException - This is thrown if the process is unsuccessful.

getDocumentEdited

public boolean getDocumentEdited()
                          throws SDKException

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

public void setDocumentEdited(boolean enable)
                       throws SDKException

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

Throws:
SDKException - This is thrown if the process is unsuccessful.

getFormatAppliedToDocument

public boolean getFormatAppliedToDocument()
                                   throws SDKException

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:

Returns:
A boolean that indicates whether the event is audited.
Throws:
SDKException - This is thrown if the process is unsuccessful.

setFormatAppliedToDocument

public void setFormatAppliedToDocument(boolean enable)
                                throws SDKException

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

Throws:
SDKException - This is thrown if the process is unsuccessful.

getPageAccessed

public boolean getPageAccessed()
                        throws SDKException

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

public void setPageAccessed(boolean enable)
                     throws SDKException

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

Throws:
SDKException - This is thrown if the process is unsuccessful.

getSQLGenerated

public boolean getSQLGenerated()
                        throws SDKException

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

public void setSQLGenerated(boolean enable)
                     throws SDKException

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

Throws:
SDKException - This is thrown if the process is unsuccessful.

getDrillOutOfScope

public boolean getDrillOutOfScope()
                           throws SDKException

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

public void setDrillOutOfScope(boolean enable)
                        throws SDKException

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.

Throws:
SDKException - This is thrown if the process is unsuccessful.