com.crystaldecisions.sdk.occa.infostore
Interface INotifications


public interface INotifications

This interface is used for setting schedule notification information. There are two types of notifications: email and audit log. Each notification will be triggered on either a “successful”, “failed”, or “successful or failed” scheduled report. Email and audit log notifications can be run simultaneously for the same scheduled report; they are not mutually exclusive.


Nested Class Summary
static interface INotifications.CeAuditOnResult
          Specifies the values for notification via audit.
 
Method Summary
 int getAuditOption()
           Returns the audit option set for notification.
 IDestinations getDestinationsOnFailure()
           Returns the notification on failure destination collection.
 IDestinations getDestinationsOnSuccess()
           Returns the notification on success destination collection.
 void setAuditOption(int option)
           Sets the audit option for notification.
 

Method Detail

getDestinationsOnSuccess

public IDestinations getDestinationsOnSuccess()
                                       throws SDKException

Returns the notification on success destination collection.

Note: Only a single SMTP destination is supported.

Returns:
A collecton that contains one SMTP target destination. The collection can also be empty.
Throws:
SDKException - This is thrown if the process is unsuccessful.

getDestinationsOnFailure

public IDestinations getDestinationsOnFailure()
                                       throws SDKException

Returns the notification on failure destination collection.

Note: Only a single SMTP destination is supported.

Returns:
A collecton that contains one SMTP target destination. The collection can also be empty.
Throws:
SDKException - This is thrown if the process is unsuccessful.

getAuditOption

public int getAuditOption()
                   throws SDKException

Returns the audit option set for notification.

Returns:
An int indicating the audit option.
Throws:
SDKException - This is thrown if the process is unsuccessful.

setAuditOption

public void setAuditOption(int option)
                    throws SDKException

Sets the audit option for notification.

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