com.ontimize.dms.filetransfer.client
Interface IFileTransferClient

All Known Implementing Classes:

FileTransferClient

public interface IFileTransferClient

Field Summary

static java.lang.String	ACTION
static java.lang.String	CONFIG_DIRECTORY
static java.lang.String	CONFIG_FILE
static java.lang.String	KEYS
static java.lang.String	M_FILE_IS_BEING_PROCESSED
static java.lang.String	M_FILE_IS_BEING_USED_REVISE_TRANSFER
static java.lang.String	M_SHOW_LOCAL_FILE_DOWNLOAD_AND_SHOW_REMOTE
static java.lang.String	M_TRYING_TO_UPLOAD_AN_INEXISTENT_FILE
static java.lang.String	PARENT_FRAME
static java.lang.String	SELECTED_FILES

Method Summary

void	clean(ContextValues context, EntityResult er)
int	doAction(int action, Document[] document, java.util.Map params)
int	doAdd(ContextValues context, java.io.File[] files) Adds the given file list to Document Manager.
int	doAdd(java.util.Map params, java.io.File[] files) Calls to doAdd(ContextValues, File[])
boolean	exists(Document document)
java.io.File	getFile(Document document)
java.lang.String	getOperationObjectName()
SaveDialog	getSaveDialog(java.awt.Window parent)
TransferStatus	getStatus()
java.lang.String	getTransferObjectName()
java.lang.String	getTransformClassName()

Field Detail

ACTION

static final java.lang.String ACTION

See Also:

Constant Field Values

KEYS

static final java.lang.String KEYS

See Also:

Constant Field Values

SELECTED_FILES

static final java.lang.String SELECTED_FILES

See Also:

Constant Field Values

PARENT_FRAME

static final java.lang.String PARENT_FRAME

See Also:

Constant Field Values

CONFIG_DIRECTORY

static final java.lang.String CONFIG_DIRECTORY

See Also:

Constant Field Values

CONFIG_FILE

static final java.lang.String CONFIG_FILE

See Also:

Constant Field Values

M_TRYING_TO_UPLOAD_AN_INEXISTENT_FILE

static final java.lang.String M_TRYING_TO_UPLOAD_AN_INEXISTENT_FILE

See Also:

Constant Field Values

M_FILE_IS_BEING_USED_REVISE_TRANSFER

static final java.lang.String M_FILE_IS_BEING_USED_REVISE_TRANSFER

See Also:

Constant Field Values

M_FILE_IS_BEING_PROCESSED

static final java.lang.String M_FILE_IS_BEING_PROCESSED

See Also:

Constant Field Values

M_SHOW_LOCAL_FILE_DOWNLOAD_AND_SHOW_REMOTE

static final java.lang.String M_SHOW_LOCAL_FILE_DOWNLOAD_AND_SHOW_REMOTE

See Also:

Constant Field Values

Method Detail

doAdd

int doAdd(java.util.Map params,
          java.io.File[] files)
          throws ContextException,
                 java.lang.Exception

Calls to doAdd(ContextValues, File[])

Throws:

ContextException

java.lang.Exception

doAdd

int doAdd(ContextValues context,
          java.io.File[] files)
          throws ContextException,
                 java.lang.Exception

Adds the given file list to Document Manager.

The files are copied to local cache and then uploaded to remote repository.

Also allows to insert if there are files with the same name if the target path. Possible options:

New version.

Overwrite

Generate a new name.

Parameters:

context - Current context.

files - List of files to insert.

Returns:

Codes.OK if files are inserted successfully.

Throws:

ContextException - if context is null.

ContextException - if context is invalid.

ContextException - if files are null or empty.

ContextException - if files has invalid characters.

ContextException - if are conflicts and no action is provided.

ContextException - if repository doesn't return a result.

ContextException - if repository doesn't return a result code.

ContextException - if repository doesn't return a list with file names.

java.lang.Exception - if a undefined error ocurrs.

Since:

0.017EN

doAction

int doAction(int action,
             Document[] document,
             java.util.Map params)

getFile

java.io.File getFile(Document document)

exists

boolean exists(Document document)

getSaveDialog

SaveDialog getSaveDialog(java.awt.Window parent)

getStatus

TransferStatus getStatus()

getTransformClassName

java.lang.String getTransformClassName()

getTransferObjectName

java.lang.String getTransferObjectName()

getOperationObjectName

java.lang.String getOperationObjectName()

clean

void clean(ContextValues context,
           EntityResult er)