com.crystaldecisions.sdk.plugin.destination.ftp
Interface IFTPOptions

All Superinterfaces:

IDestinationScheduleOptions

public interface IFTPOptions
extends IDestinationScheduleOptions

The IFTPOptions object allows you to set the global or schedule options to an FTP location.

Method Summary

void	clearServerInfo() Clears all settings related to server connection and authentication: Server Name Port User Name Password If these fields are cleared, when the InfoObject is processed the defaults specified on the processing Job Server will be used for connection and authentication.
java.lang.String	getAccount() Returns the FTP account to log on to.
java.util.List	getDestinationFiles() Returns the collection used to add, delete, and modify FTP destination files.
IDestinationOutputByDocs	getDestinationFilesByDocs() Destination output files personalized for individual source documents.
int	getPort() Returns the FTP server listening port.
java.lang.String	getServerName() Returns the FTP server name.
java.lang.String	getUserName() Returns the FTP logon name.
boolean	isPasswordNotEmpty() Returns a boolean indicating whether the password is set and not empty.
boolean	isPasswordSet() Returns a boolean indicating whether the password is set.
void	setAccount(java.lang.String sVal) Sets the FTP account to log on to.
void	setPassword(java.lang.String sVal) Sets the password to log on to the FTP server.
void	setPort(int lVal) Sets the FTP server listening port.
void	setServerName(java.lang.String sVal) Sets the FTP server name.
void	setUserName(java.lang.String sVal) Sets the FTP logon name.

Methods inherited from interface com.crystaldecisions.sdk.plugin.destination.common.IDestinationScheduleOptions

getInputFiles

Method Detail

getServerName

java.lang.String getServerName()

Returns the FTP server name.

Returns:

A String containing the FTP server name.

setServerName

void setServerName(java.lang.String sVal)

Sets the FTP server name.

Parameters:

sVal - A String containing the FTP server name.

getPort

int getPort()

Returns the FTP server listening port.

Returns:

An int specifying the FTP server listening port.

setPort

void setPort(int lVal)

Sets the FTP server listening port.

Parameters:

lVal - An int specifying the FTP server listening port.

getUserName

java.lang.String getUserName()

Returns the FTP logon name.

Returns:

A String containing the FTP logon name.

setUserName

void setUserName(java.lang.String sVal)

Sets the FTP logon name.

Parameters:

sVal - A String containing the FTP logon name.

setPassword

void setPassword(java.lang.String sVal)

Sets the password to log on to the FTP server.

Parameters:

sVal - A String containing the password to log on to the FTP server.

isPasswordSet

boolean isPasswordSet()
                      throws SDKException

Returns a boolean indicating whether the password is set.

Returns:

true if the password is set, falseThrows:

SDKException - This is thrown if the process is unsuccessful.

isPasswordNotEmpty

boolean isPasswordNotEmpty()
                           throws SDKException

Returns a boolean indicating whether the password is set and not empty.

Returns:

true if the password is set and not empty, falseThrows:

SDKException - This is thrown if the process is unsuccessful.

clearServerInfo

void clearServerInfo()

Clears all settings related to server connection and authentication:
Server Name
Port
User Name
Password
If these fields are cleared, when the InfoObject is processed the defaults specified on the processing Job Server will be used for connection and authentication.

getAccount

java.lang.String getAccount()

Returns the FTP account to log on to. This can be left empty.

Returns:

A String containing the FTP account to log on to.

setAccount

void setAccount(java.lang.String sVal)

Sets the FTP account to log on to. This can be left empty.

Parameters:

sVal - A String containing the FTP account to log on to.

getDestinationFiles

java.util.List getDestinationFiles()

Returns the collection used to add, delete, and modify FTP destination files.

Returns:

A List containing the collection used to add, delete, and modify FTP destination files. This List contains String objects.

getDestinationFilesByDocs

IDestinationOutputByDocs getDestinationFilesByDocs()

Destination output files personalized for individual source documents. The output is a collection of file collections associated with each source document. Each element is of type IDestinationOutputPerDoc which, in this case, represents a file collection of type String.

Returns:

IDestinationFilesByDocs A collection of file collections associated with each source document.