com.crystaldecisions.sdk.plugin.desktop.server
Interface IServerDestination

public interface IServerDestination

This interface provides access to the destination options and status for a server destination.

Method Summary

boolean	getActualStatus() Returns the status for this server destination.
IDestinationScheduleOptions	getConfigActualGlobalOptions() Returns the destination scheduling options for this server destination.
IDestinationScheduleOptions	getConfigGlobalOptions() Returns the destination scheduling options for this server destination.
java.lang.String	getName() Returns the name of the server destination.
boolean	getRequestedStatus() Returns the desired status for this server destination.
void	setRequestedStatus(boolean enabled) Sets the desired status for this server destination.

Method Detail

getName

java.lang.String getName()

Returns the name of the server destination.

Returns:

The name of the server destination.

getRequestedStatus

boolean getRequestedStatus()

Returns the desired status for this server destination.

Returns:

true if this server destinatinon should be enabled, false otherwise.

setRequestedStatus

void setRequestedStatus(boolean enabled)
                        throws SDKException

Sets the desired status for this server destination.

Parameters:

true - if this server destination should be enabled, false otherwise.

Throws:

SDKException

getActualStatus

boolean getActualStatus()

Returns the status for this server destination.

Returns:

true if this server destinatinon is enabled, false otherwise.

getConfigGlobalOptions

IDestinationScheduleOptions getConfigGlobalOptions()
                                                   throws SDKException

Returns the destination scheduling options for this server destination. The values returned by this method represent the desired settings for the scheduling options.

Returns:

An interface to the destination scheduling options.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getConfigActualGlobalOptions

IDestinationScheduleOptions getConfigActualGlobalOptions()
                                                         throws SDKException

Returns the destination scheduling options for this server destination.

Returns:

An interface to the destination scheduling options.

Throws:

SDKException - This is thrown if the process is unsuccessful.