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


public interface IJobServerAuditAdmin

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


Method Summary
 boolean isJobFailed()
           Returns a boolean indicating whether the CMS audits jobs that failed on the Job Server.
 boolean isJobFailedButRetried()
           Returns a boolean indicating whether the CMS audits jobs that failed on the Job Server, and will be retried again.
 boolean isJobSucceeded()
           Returns a boolean indicating whether the CMS audits jobs that succeeded on the Job Server.
 void setJobFailed(boolean value)
           Sets whether the CMS audits jobs that failed on the Job Server.
 void setJobFailedButRetried(boolean value)
           Sets whether the CMS audits jobs that failed on the Job Server, and will be retried again.
 void setJobSucceeded(boolean value)
           Sets whether the CMS audits jobs that succeeded on the Job Server.
 

Method Detail

isJobSucceeded

public boolean isJobSucceeded()
                       throws SDKException

Returns a boolean indicating whether the CMS audits jobs that succeeded on the Job Server.

Returns:
A boolean indicating whether the CMS audits jobs that succeeded on the Job Server.
Throws:
SDKException - This is thrown if the process is unsuccessful.

setJobSucceeded

public void setJobSucceeded(boolean value)
                     throws SDKException

Sets whether the CMS audits jobs that succeeded on the Job Server.

Parameters:
value - A boolean indicating whether the CMS audits jobs that succeeded on the Job Server.
Throws:
SDKException - This is thrown if the process is unsuccessful.

isJobFailed

public boolean isJobFailed()
                    throws SDKException

Returns a boolean indicating whether the CMS audits jobs that failed on the Job Server.

Returns:
A boolean indicating whether the CMS audits jobs that failed on the Job Server.
Throws:
SDKException - This is thrown if the process is unsuccessful.

setJobFailed

public void setJobFailed(boolean value)
                  throws SDKException

Sets whether the CMS audits jobs that failed on the Job Server.

Parameters:
value - A boolean indicating whether the CMS audits jobs that failed on the Job Server.
Throws:
SDKException - This is thrown if the process is unsuccessful.

isJobFailedButRetried

public boolean isJobFailedButRetried()
                              throws SDKException

Returns a boolean indicating whether the CMS audits jobs that failed on the Job Server, and will be retried again.

Returns:
A boolean indicating whether the CMS audits jobs that failed on the Job Server, and will be retried again.
Throws:
SDKException - This is thrown if the process is unsuccessful.

setJobFailedButRetried

public void setJobFailedButRetried(boolean value)
                            throws SDKException

Sets whether the CMS audits jobs that failed on the Job Server, and will be retried again.

Parameters:
value - A boolean indicating whether the CMS audits jobs that failed on the Job Server, and will be retried again.
Throws:
SDKException - This is thrown if the process is unsuccessful.