com.ibm.productivity.tools.ui.views.operations
Interface SaveAsOperation

All Superinterfaces:
Operation

public interface SaveAsOperation
extends Operation

Defines the operation to save the document in the rich document view as a new file.

If a file name that is not valid is provided, UnsupportedOperationException is thrown when starting the operation on a RichDocumentView. For example, when the specified file is read only.

The user can set the target file name before starting the operation.

Since:
8.0.1
See Also:
Operation

Method Summary
 java.lang.String getFileName()
          Specifies the absolute path for the new file path.
 void setFileName(java.lang.String fileName)
          Sets the absolute path for the new file path.
 

Method Detail

getFileName

public java.lang.String getFileName()
Specifies the absolute path for the new file path. For example, c:\\test.odt on Windows® operating systems, and /home/test.odt on Linux® operating systems.

Returns:
the absolute path for the new file path

setFileName

public void setFileName(java.lang.String fileName)
Sets the absolute path for the new file path. For example, c:\\test.odt on Windows® operating systems, and /home/test.odt on Linux® operating systems.


The user can set the value before the operation is started.

Parameters:
fileName - the absolute path for the new file path