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

Deprecated. As of version 12.0.

public interface IAuditAdmin

The IAuditAdmin interface allows you to choose the specific server(s) you would like to audit. IAuditAdmin also enables the audit functionality, and sets the location of the log directory for each server. The IAuditAdmin interface is used by each server audit object.

Method Summary

void	commit() Deprecated. As of version 12.0. Commit the Job Server InfoObject to save any changes.
java.lang.String	getLogDir() Deprecated. As of version 12.0.
java.lang.Object	getServerAuditAdmin() Deprecated. As of version 12.0.
java.lang.String	getServerKind() Deprecated. As of version 12.0.
boolean	getStatus() Deprecated. As of version 12.0.
void	setLogDir(java.lang.String logDir) Deprecated. As of version 12.0.
void	setStatus(boolean status) Deprecated. As of version 12.0.

Method Detail

getServerKind

java.lang.String getServerKind()
                               throws SDKException

Deprecated. As of version 12.0.

Returns the name of the server that is being audited.

Returns:

A String containing the name of the server that is being audited.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getServerAuditAdmin

java.lang.Object getServerAuditAdmin()
                                     throws SDKException

Deprecated. As of version 12.0.

Returns each audit admin interface associated only with this server.

Returns:

Each audit admin interface Object associated with this server.

Throws:

SDKException - This is thrown if the process is unsuccessful.

commit

void commit()
            throws SDKException

Deprecated. As of version 12.0. Commit the Job Server InfoObject to save any changes.

Commits auditing information back to the associated server.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getStatus

boolean getStatus()
                  throws SDKException

Deprecated. As of version 12.0.

Returns a boolean indicating whether or not the auditing feature is enabled.

Returns:

true if auditing is enabled, false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setStatus

void setStatus(boolean status)
               throws SDKException

Deprecated. As of version 12.0.

Sets the auditing function on or off.

Parameters:

status - A boolean indicating whether or not the auditing function will be enabled or disabled.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getLogDir

java.lang.String getLogDir()
                           throws SDKException

Deprecated. As of version 12.0.

Returns the Audit log directory.

Returns:

A String containing the location of the Audit log directory.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setLogDir

void setLogDir(java.lang.String logDir)
               throws SDKException

Deprecated. As of version 12.0.

Sets the Audit log directory.

Parameters:

logDir - A String containing the location of the Audit log directory.

Throws:

SDKException - This is thrown if the process is unsuccessful.