com.businessobjects.enterprise.infoobject
Interface AlertDestination

public interface AlertDestination

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),

Five types of destinations are supported by 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. Printer options are set with the Report plugin instead of a destination plugin.

Nested Class Summary

static class

AlertDestination.Factory A class with methods for creating instances of the AlertDestination type.

Field Summary

static org.apache.xmlbeans.SchemaType

type

Method Summary

DestinationScheduleOptions	addNewDestinationScheduleOptions() Internal Use Only.
DestinationScheduleOptions	getDestinationScheduleOptions() Internal Use Only.
java.lang.String	getName() Returns the name of the destination.
boolean	isSetDestinationScheduleOptions() Internal Use Only.
boolean	isSetName() Checks if the Name has been set.
void	setDestinationScheduleOptions(DestinationScheduleOptions destinationScheduleOptions) Internal Use Only.
void	setName(java.lang.String name) Sets the name of the destination.
void	unsetDestinationScheduleOptions() Internal Use Only.
void	unsetName() Deletes or unsets the Name element.
org.apache.xmlbeans.XmlString	xgetName() Internal Use Only.
void	xsetName(org.apache.xmlbeans.XmlString name) Internal Use Only.

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Method Detail

getDestinationScheduleOptions

DestinationScheduleOptions getDestinationScheduleOptions()

Internal Use Only.

isSetDestinationScheduleOptions

boolean isSetDestinationScheduleOptions()

Internal Use Only.

setDestinationScheduleOptions

void setDestinationScheduleOptions(DestinationScheduleOptions destinationScheduleOptions)

Internal Use Only.

addNewDestinationScheduleOptions

DestinationScheduleOptions addNewDestinationScheduleOptions()

Internal Use Only.

unsetDestinationScheduleOptions

void unsetDestinationScheduleOptions()

Internal Use Only.

getName

java.lang.String getName()

Returns the name of the destination.

Returns:

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

xgetName

org.apache.xmlbeans.XmlString xgetName()

Internal Use Only.

isSetName

boolean isSetName()

Checks if the Name has been set.

Returns:

true if the Name element has been set,otherwise false.

setName

void setName(java.lang.String name)

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

Parameters:

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

xsetName

void xsetName(org.apache.xmlbeans.XmlString name)

Internal Use Only.

unsetName

void unsetName()

Deletes or unsets the Name element.