com.crystaldecisions.sdk.plugin.destination.diskunmanaged
Interface IDiskUnmanagedOptions

All Superinterfaces:

IDestinationScheduleOptions

public interface IDiskUnmanagedOptions
extends IDestinationScheduleOptions

The IDiskUnmanagedOptions interface allows you to set the global or schedule options to an unmanaged disk location.

Method Summary

java.util.List	getDestinationFiles() Returns the collection used to add, delete, and modify unmanaged disk files.
IDestinationOutputByDocs	getDestinationFilesByDocs() Destination output files personalized for individual source documents.
java.lang.String	getUserName() Returns the user name to log on to a remote file system.
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	setPassword(java.lang.String sVal) Sets the password to log on to a remote file system.
void	setUserName(java.lang.String sVal) Sets the user name to log on to a remote file system.

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

getInputFiles

Method Detail

getUserName

java.lang.String getUserName()

Returns the user name to log on to a remote file system.

Returns:

A String containing the user name to log on to a remote file system.

setUserName

void setUserName(java.lang.String sVal)

Sets the user name to log on to a remote file system.

Parameters:

sVal - A String containing the operating system user name to log on to a remote file system.

setPassword

void setPassword(java.lang.String sVal)

Sets the password to log on to a remote file system.

Parameters:

sVal - A String containing the password to log on to a remote file system.

isPasswordSet

boolean isPasswordSet()
                      throws SDKException

Returns a boolean indicating whether the password is set.

Throws:

SDKException

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, false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getDestinationFiles

java.util.List getDestinationFiles()

Returns the collection used to add, delete, and modify unmanaged disk files.

Returns:

A List containing the collection used to add, delete, and modify unmanaged disk 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.