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

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

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

int getAuditOption()
                   throws SDKException

Returns the audit option set for notification.

The AuditOption property can be set to one of four INotifications.CeAuditOnResult values: ceAuditNone, ceAuditOnBoth, ceAuditOnFailure, or ceAuditOnSuccess.

AuditOption is a logical OR of the settings on the object and the settings on the jobserver. In other words, Audit settings can be applied to an object directly or from the jobserver.

Object	Jobserver	Result
0	1	1
1	0	1
1	1	1
0	0	0

For example, if auditing is disabled on the object (by setting Notifications.AuditOption = ceAuditNone), and audit on success is enabled on the jobserver for that object, if the object is run successfully, then an audit entry is created.

Returns:

An int indicating the audit option. The value corresponds to one of the constants in INotifications.CeAuditOnResult.

Throws:

SDKException - This is thrown if the process is unsuccessful.

See Also:

INotifications.setAuditOption(int)

setAuditOption

void setAuditOption(int option)
                    throws SDKException

Sets the audit option for notification.

The AuditOption property can be set to one of four INotifications.CeAuditOnResult values: ceAuditNone, ceAuditOnBoth, ceAuditOnFailure, or ceAuditOnSuccess.

AuditOption is a logical OR of the settings on the object and the settings on the jobserver. In other words, Audit settings can be applied to an object directly or from the jobserver.

Object	Jobserver	Result
0	1	1
1	0	1
1	1	1
0	0	0

For example, if auditing is disabled on the object (by setting Notifications.AuditOption = ceAuditNone), and audit on success is enabled on the jobserver for that object, if the object is run successfully, then an audit entry is created.

Parameters:

option - An int specifying the audit option.

Throws:

SDKException - This is thrown if the process is unsuccessful.