com.crystaldecisions.sdk.occa.infostore
Interface IDestinationPlugin

All Known Subinterfaces:

IDiskUnmanaged, IFTP, IManaged, ISFTP, ISMTP, IStreamWork

public interface IDestinationPlugin

This interface defines Destination plugins that allow reports to be scheduled to specific destinations. There are three types of Destination plugins, each of which is implemented in one of the following packages:

• DiskUnmanaged PlugIn Package
• Managed PlugIn Package
• FTP PlugIn Package
• SMTP PlugIn Package

This object allows you to view the properties, as well as the scheduling options, that have been set for a particular Destination plugin. Use the IDestination object's setFromPlugin method to set these Destination plugin properties and scheduling options on the object that is being scheduled, and the copyToPlugin method to copy the IDestination object's properties to the Destination plugin so that they can be viewed through the plugin.

Method Summary

java.lang.Object	getScheduleOptions() Returns the schedule option interface.
IProperties	properties() Returns all the properties of the Destination Plugin.

Method Detail

properties

IProperties properties()

Returns all the properties of the Destination Plugin.

Returns:

An IProperties object containing the properties of the Destination Plugin.

getScheduleOptions

java.lang.Object getScheduleOptions()

Returns the schedule option interface. Each destination plugin will support a destination specific interface. For example, if the current plugin is the 'CrystalEnterprise.Smtp' destination, then the schedule option interface will be the corresponding ISMTPOptions interface. This object can also be cast as one of the following objects:

• IFTPOptions
• IDiskUnmanagedOptions
• IManagedOptions

Returns:

An Object corresponding to the Destination plugin's schedule option interface.

See Also:

com.crystaldecisions.sdk.plugin.destination.diskunmanaged, com.crystaldecisions.sdk.plugin.destination.managed, com.crystaldecisions.sdk.plugin.destination.ftp, com.crystaldecisions.sdk.plugin.destination.smtp

InfoObject properties to query for:

SI_DEST_SCHEDULEOPTIONS