com.crystaldecisions.sdk.plugin.admin.jobserveradmin
Interface IJobServerDestination

public interface IJobServerDestination

The IJobServerDestination interface allows you to retrieve the plugin associated with the output destination (FTP, SMTP, or Unmanaged Disk) of a scheduled object as well as enable or disable that destination. The destination plugin is used to set the Job Server's global options for that destination type. For more information see "Selecting a Destination" in the BusinessObjects Enterprise Administrator's Guide.

Method Summary

java.lang.String	getName() Returns the ProgID of the Destination Plugin.
java.lang.Object	getPluginInterface() Returns the Destination Plugin interface.
boolean	isEnabled() Returns whether the destination is enabled.
void	setEnabled(boolean enabled) Sets whether the destination is enabled.

Method Detail

getName

public java.lang.String getName()
                         throws SDKException

Returns the ProgID of the Destination Plugin.

Returns:

A String containing the ProgID of the Destination Plugin.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getPluginInterface

public java.lang.Object getPluginInterface()
                                    throws SDKException

Returns the Destination Plugin interface.

Returns:

An Object containing the Destination Plugin Options interface. This can be cast as a destination specific options interface.

Throws:

SDKException - This is thrown if the process is unsuccessful.

See Also:

IDestinationPlugin

isEnabled

public boolean isEnabled()
                  throws SDKException

Returns whether the destination is enabled.

Returns:

A boolean specifying whether the destination is enabled.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setEnabled

public void setEnabled(boolean enabled)
                throws SDKException

Sets whether the destination is enabled.

Parameters:

enabled - true if the destination is enabled, false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.