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

public interface IFTPOptions

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

Method Summary

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.
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.

Method Detail

getServerName

public java.lang.String getServerName()

Returns the FTP server name.

Returns:

A String containing the FTP server name.

setServerName

public void setServerName(java.lang.String sVal)

Sets the FTP server name.

Parameters:

sVal - A String containing the FTP server name.

getPort

public int getPort()

Returns the FTP server listening port. The default value is 21.

Returns:

An int specifying the FTP server listening port.

setPort

public void setPort(int lVal)

Sets the FTP server listening port. The default is 21.

Parameters:

lVal - An int specifying the FTP server listening port.

getUserName

public java.lang.String getUserName()

Returns the FTP logon name. The default is Anonymous.

Returns:

A String containing the FTP logon name.

setUserName

public void setUserName(java.lang.String sVal)

Sets the FTP logon name. The default is Anonymous.

Parameters:

sVal - A String containing the FTP logon name.

setPassword

public void setPassword(java.lang.String sVal)

Sets the password to log on to the FTP server. The default is CrystalDecisions.com.

Parameters:

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

isPasswordSet

public 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

public 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.

getAccount

public 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

public 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

public 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.