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

Deprecated. As of version 12.0.

public interface ICMSAuditAdmin

The ICMSAuditAdmin interface provides auditing information to the Central Management Server (CMS). This interface allows you to monitor both folder and user actions. In this situation the CMS functions as the auditor and the auditee. Furthermore, when a new ICMSAuditAdmin object is created, it supplies its own functionality and inherits the methods that are associated with the IAuditAdmin interface.

Method Summary

boolean	isConcurrentLogonSucceeded() Deprecated. As of version 12.0.
boolean	isFolderCreation() Deprecated. As of version 12.0.
boolean	isFolderDeletion() Deprecated. As of version 12.0.
boolean	isFolderModification() Deprecated. As of version 12.0.
boolean	isJobIncomplete() Deprecated. As of version 12.0.
boolean	isLogonFailed() Deprecated. As of version 12.0.
boolean	isNamedLogonSucceeded() Deprecated. As of version 12.0.
boolean	isObjectCreation() Deprecated. As of version 12.0.
boolean	isObjectDeletion() Deprecated. As of version 12.0.
boolean	isObjectModification() Deprecated. As of version 12.0.
boolean	isPasswordChanged() Deprecated. As of version 12.0.
boolean	isRightsModification() Deprecated. As of version 12.0.
boolean	isUserLogoff() Deprecated. As of version 12.0.
void	setConcurrentLogonSucceeded(boolean value) Deprecated. As of version 12.0.
void	setFolderCreation(boolean value) Deprecated. As of version 12.0.
void	setFolderDeletion(boolean value) Deprecated. As of version 12.0.
void	setFolderModification(boolean value) Deprecated. As of version 12.0.
void	setJobIncomplete(boolean value) Deprecated. As of version 12.0.
void	setLogonFailed(boolean value) Deprecated. As of version 12.0.
void	setNamedLogonSucceeded(boolean value) Deprecated. As of version 12.0.
void	setObjectCreation(boolean value) Deprecated. As of version 12.0.
void	setObjectDeletion(boolean value) Deprecated. As of version 12.0.
void	setObjectModification(boolean value) Deprecated. As of version 12.0.
void	setPasswordChanged(boolean value) Deprecated. As of version 12.0.
void	setRightsModification(boolean value) Deprecated. As of version 12.0.
void	setUserLogoff(boolean value) Deprecated. As of version 12.0.

Method Detail

isConcurrentLogonSucceeded

boolean isConcurrentLogonSucceeded()
                                   throws SDKException

Deprecated. As of version 12.0.

Returns a boolean indicating whether the CMS audits user logons that are concurrent and successful.

Returns:

A boolean indicating whether the CMS audits user logons that are concurrent and successful.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setConcurrentLogonSucceeded

void setConcurrentLogonSucceeded(boolean value)
                                 throws SDKException

Deprecated. As of version 12.0.

Sets whether the CMS audits user logons that are concurrent and successful.

Parameters:

value - A boolean indicating whether or not the CMS audits user logons that are concurrent and successful. This will be either true or false.

Throws:

SDKException - This is thrown if the process is unsuccessful.

isNamedLogonSucceeded

boolean isNamedLogonSucceeded()
                              throws SDKException

Deprecated. As of version 12.0.

Returns a boolean indicating whether or not the CMS audits named logons that succeeded.

Returns:

A boolean indicating whether or not the CMS audits successful named logons.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setNamedLogonSucceeded

void setNamedLogonSucceeded(boolean value)
                            throws SDKException

Deprecated. As of version 12.0.

Sets whether the CMS audits named logons that succeeded.

Parameters:

value - A boolean indicating whether or not the CMS audits successful named logons. This will be either true or false.

Throws:

SDKException - This is thrown if the process is unsuccessful.

isLogonFailed

boolean isLogonFailed()
                      throws SDKException

Deprecated. As of version 12.0.

Returns a boolean indicating whether the CMS audits user logons that failed. The possible causes of a user logon failure are as follows:

• invalid license key
• unknown user
• disabled user account
• the concurrent user limit has been reached
• invalid password
• the user chooses standard logon mode; in standard logon mode, the only valid user
  names are administrator and guest.

Returns:

A boolean indicating whether or not the CMS audits user logons that failed.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setLogonFailed

void setLogonFailed(boolean value)
                    throws SDKException

Deprecated. As of version 12.0.

Sets whether the CMS audits user logons that failed.

Parameters:

value - A boolean indicating whether or not the CMS audits user logons that failed. This will be either true or false.

Throws:

SDKException - This is thrown if the process is unsuccessful.

isUserLogoff

boolean isUserLogoff()
                     throws SDKException

Deprecated. As of version 12.0.

Returns a boolean indicating whether the CMS audits user logoffs.

Returns:

A boolean indicating whether or not the CMS audits user logoffs.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setUserLogoff

void setUserLogoff(boolean value)
                   throws SDKException

Deprecated. As of version 12.0.

Sets whether the CMS audits user logoffs.

Parameters:

value - A boolean indicating whether or not the CMS audits user logoffs. This will be either true or false.

Throws:

SDKException - This is thrown if the process is unsuccessful.

isPasswordChanged

boolean isPasswordChanged()
                          throws SDKException

Deprecated. As of version 12.0.

Returns a boolean indicating whether the CMS audits passwords that have been changed.

Returns:

A boolean indicating whether or not the CMS audits passwords that have been changed.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setPasswordChanged

void setPasswordChanged(boolean value)
                        throws SDKException

Deprecated. As of version 12.0.

Sets whether the CMS audits passwords that have been changed.

Parameters:

value - A boolean indicating whether or not the CMS audits passwords that have been changed. This will be either true or false.

Throws:

SDKException - This is thrown if the process is unsuccessful.

isFolderCreation

boolean isFolderCreation()
                         throws SDKException

Deprecated. As of version 12.0.

Returns a boolean indicating whether the CMS audits creations of new folders.

Returns:

A boolean indicating whether or not the CMS audits creations of new folders.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setFolderCreation

void setFolderCreation(boolean value)
                       throws SDKException

Deprecated. As of version 12.0.

Sets whether the CMS audits creations of new folders.

Parameters:

A - boolean indicating whether or not the CMS audits creations of new folders. This will be either true or false.

Throws:

SDKException - This is thrown if the process is unsuccessful.

isFolderDeletion

boolean isFolderDeletion()
                         throws SDKException

Deprecated. As of version 12.0.

Returns a boolean indicating whether the CMS audits deletions of folders.

Returns:

A boolean indicating whether or not the CMS audits deletions of folders.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setFolderDeletion

void setFolderDeletion(boolean value)
                       throws SDKException

Deprecated. As of version 12.0.

Sets whether the CMS audits deletions of folders.

Parameters:

value - A boolean indicating whether or not the CMS audits deletions of folders. This will be either true or false.

Throws:

SDKException - This is thrown if the process is unsuccessful.

isFolderModification

boolean isFolderModification()
                             throws SDKException

Deprecated. As of version 12.0.

Returns a boolean indicating whether the CMS audits the modifications of folders. The CMS considers a modification to be a change in the name, location, or description of a folder.

Returns:

A boolean indicating whether or not the CMS audits the modifications of folders.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setFolderModification

void setFolderModification(boolean value)
                           throws SDKException

Deprecated. As of version 12.0.

Sets whether the CMS audits the modifications of folders. The CMS considers a modification to be a change in the name, location, or description of a folder.

Parameters:

value - A boolean indicating whether or not the CMS audits the modifications of folders.

Throws:

SDKException - This is thrown if the process is unsuccessful.

isJobIncomplete

boolean isJobIncomplete()
                        throws SDKException

Deprecated. As of version 12.0.

Returns a boolean indicating whether the CMS audits incomplete jobs.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setJobIncomplete

void setJobIncomplete(boolean value)
                      throws SDKException

Deprecated. As of version 12.0.

Sets whether the CMS audits for incomplete jobs.

Parameters:

value - A boolean specifying whether or not the CMS audits for incomplete jobs. A true value indicates that the CMS will audit for incomplete jobs, false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.

isObjectCreation

boolean isObjectCreation()
                         throws SDKException

Deprecated. As of version 12.0.

Returns a boolean value that indicates whether the CMS audits creations of new objects.

Returns:

A boolean value that indicates whether the CMS audits creations of new objects.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setObjectCreation

void setObjectCreation(boolean value)
                       throws SDKException

Deprecated. As of version 12.0.

Sets whether the CMS audits creations of new objects.

Parameters:

A - boolean indicating whether or not the CMS audits creations of new objects. This will be either true or false.

Throws:

SDKException - This is thrown if the process is unsuccessful.

isObjectDeletion

boolean isObjectDeletion()
                         throws SDKException

Deprecated. As of version 12.0.

Returns a boolean value that indicates whether the CMS audits the deletion of objects.

Returns:

A boolean value that indicates whether the CMS audits the deletion of objects.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setObjectDeletion

void setObjectDeletion(boolean value)
                       throws SDKException

Deprecated. As of version 12.0.

Sets whether the CMS audits deletions of objects.

Parameters:

value - A boolean that indicates whether the CMS audits the deletion of objects.

Throws:

SDKException - This is thrown if the process is unsuccessful.

isObjectModification

boolean isObjectModification()
                             throws SDKException

Deprecated. As of version 12.0.

Returns a boolean value that indicates whether the CMS audits the modification of objects. The CMS considers a modification to be a change in the name, location, or description of an object.

Returns:

A boolean value that indicates whether the CMS audits the modification of objects.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setObjectModification

void setObjectModification(boolean value)
                           throws SDKException

Deprecated. As of version 12.0.

Sets whether the CMS audits the modifications of objects. The CMS considers a modification to be a change in the name, location, or description of an object.

Parameters:

value - A boolean value that indicates whether the CMS audits the modification of objects.

Throws:

SDKException - This is thrown if the process is unsuccessful.

isRightsModification

boolean isRightsModification()
                             throws SDKException

Deprecated. As of version 12.0.

Returns a boolean value that indicates whether the CMS audits the modification of rights.

Returns:

A boolean value that indicates whether the CMS audits the modification of rights.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setRightsModification

void setRightsModification(boolean value)
                           throws SDKException

Deprecated. As of version 12.0.

Sets whether the CMS audits the modification of rights.

Parameters:

value - A boolean value that indicates whether the CMS audits the modification of rights.

Throws:

SDKException - This is thrown if the process is unsuccessful.