com.crystaldecisions.sdk.occa.infostore
Interface IDestination

public interface IDestination

This object is used to specify the output destination of a scheduled job. If you do not specify a destination, scheduled report instances will only be saved on the File Repository Server (FRS),

Four types of destinations are supported by SAP BusinessObjects Enterprise:

• FTP - The instance can be copied to a server using FTP.
• SMTP - The instance can be emailed to a person.
• DiskUnmanaged - The instance can be copied to the local disk or somewhere on the network.
• Managed - The instance can be copied to the managed destination.
• Printer - The instance can be printed to a local or network printer.

FTP, SMTP, Managed and DiskUnmanaged are generic destinations that can be used with other object types. However, Printer is a report format specific destination and can only be used when the report object is a Crystal Report. While FTP, SMTP, Managed and DiskUnmanaged scheduling options are provided through the SchedulingInfo object when you schedule a report, the Printer options are set using the Report object.

The options for each destination, with the exception of the printer, are provided through the appropriate destination plugin. Each plugin must be enabled through the IJobServerDestination object or the Crystal Management Console's Job Server properties. Printer options are set with the Report plugin instead of a destination plugin.

As well as providing a way to enable each destination plugin, the IJobServerDestination object allows you to retrieve the destination plugin and set the global options for that particular Job Server. These are the Job Server's default destination settings. When you set the destination for a particular report, you can keep the Job Server's defaults, or you can specify scheduling options for the plugin. If scheduling options are specified, then these settings will override the Job Server's global options. Once the plugin's properties are specified, they can be set on the object being scheduled using the setFromPlugin method.

See Also:

ISchedulingInfo, IJobServerDestination

Method Summary

void	clear() Clears all destination properties except destination name.
void	copyToPlugin(IDestinationPlugin plugin) Copies destination properties to the destination plugin.
IDestinationFormats	getDestinationFormats() Returns a IDestinationFormats that indicates the collection of formats for this destination.
IDestinationPluginArtifactFormats	getDestinationPluginArtifactFormats() Returns a IDestinationPluginArtifactFormats that indicates the collection of plugin-generated artifact formats for this destination.
IDestinationStaticDocuments	getDestinationStaticDocuments() Returns a IDestinationStaticDocuments that indicates the collection of static documents to be delivered with the document
java.lang.String	getName() Returns the name of the destination.
boolean	isCleanup() Deprecated. Use the isCleanup method defined in IDestinations instead
boolean	isDeliverPerUser() Returns a boolean that indicates whether the publication output will be delivered to each user.
boolean	isSystemDefaultOptionsUsed() Returns a boolean that indicates whether the job server default destination options are used.
IProperties	properties() Returns the IProperties object for the Destination plugin.
void	setCleanup(boolean cleanup) Deprecated. Use the setCleanup method defined in IDestinations instead
void	setDeliverPerUser(boolean perUser) Sets the flag indicating whether the publication output will be delivered to each user
void	setFromPlugin(IDestinationPlugin plugin) Sets destination properties from the destination plugin to the current IDestination object.
void	setName(java.lang.String Name) Sets the name of the destination.

Method Detail

getName

java.lang.String getName()

Returns the name of the destination.

Returns:

A String containing the name of the destination of the scheduled job.

setName

void setName(java.lang.String Name)

Sets the name of the destination. In order to disable IReportAlert notification for a report, use this method and set the destination name to an empty String.

Parameters:

Name - The name of the destination as a String.

properties

IProperties properties()

Returns the IProperties object for the Destination plugin.

Returns:

The IProperties object for the Destination plugin.

copyToPlugin

void copyToPlugin(IDestinationPlugin plugin)
                  throws SDKException

Copies destination properties to the destination plugin.

Parameters:

plugin - The IDestinationPlugin that you want to copy the destination properties to.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setFromPlugin

void setFromPlugin(IDestinationPlugin plugin)
                   throws SDKException

Sets destination properties from the destination plugin to the current IDestination object.

Parameters:

plugin - The IDestinationPlugin whose properties you want to use to set properties in the current IDestination object.

Throws:

SDKException - This is thrown if the process is unsuccessful.

clear

void clear()

Clears all destination properties except destination name.

isSystemDefaultOptionsUsed

boolean isSystemDefaultOptionsUsed()

Returns a boolean that indicates whether the job server default destination options are used.

Returns:

true if the job server default destination options are used, and false otherwise.

isCleanup

boolean isCleanup()
                  throws SDKException

Deprecated. Use the isCleanup method defined in IDestinations instead

Retuns a boolean that indicates whether the instance is cleaned up after the object has been scheduled and processed.

Returns:

true if the instance is cleaned up after the object has been scheduled and processed, and false otherwise.

Throws:

SDKException

setCleanup

void setCleanup(boolean cleanup)
                throws SDKException

Deprecated. Use the setCleanup method defined in IDestinations instead

Sets a boolean that indicates whether the instance is cleaned up after the object has been scheduled and processed.

Parameters:

cleanup - A boolean that specifies whether the instance is cleaned up after the object has been scheduled and processed.

Throws:

SDKException

setDeliverPerUser

void setDeliverPerUser(boolean perUser)

Sets the flag indicating whether the publication output will be delivered to each user

Parameters:

perUser - boolean indicating whether the publication output will be delivered to each user

isDeliverPerUser

boolean isDeliverPerUser()

Returns a boolean that indicates whether the publication output will be delivered to each user.

Returns:

true if the publication output will be delivered to each user, false otherwise.

getDestinationFormats

IDestinationFormats getDestinationFormats()

Returns a IDestinationFormats that indicates the collection of formats for this destination.

Returns:

IDestinationFormats the collection of formats(indexes of processingInfo's formats).

getDestinationPluginArtifactFormats

IDestinationPluginArtifactFormats getDestinationPluginArtifactFormats()

Returns a IDestinationPluginArtifactFormats that indicates the collection of plugin-generated artifact formats for this destination.

Returns:

IDestinationPluginArtifactFormats the collection of plugin-generated artifact formats for the destination.

getDestinationStaticDocuments

IDestinationStaticDocuments getDestinationStaticDocuments()

Returns a IDestinationStaticDocuments that indicates the collection of static documents to be delivered with the document

Returns:

IDestinationStaticDocuments the collection of static documents delived to the destination