Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: ucb ::

struct TransferInfo
Description
contains information needed to transfer objects from one location to another.

The transfer command is always called on the target folder. For a details description of the transfer command refer to the documentation of service Content.


Elements' Summary
MoveData contains the flags describing whether the data shall be moved instead of copied.  
SourceURL contains the URL of the source of the action (e.g. the URL of a file to move).  
NewTitle contains the title of the transferred object, if it is different from the original one.  
NameClash describes how to act in case of title clashes while transferring the data.  
Elements' Details
MoveData
boolean MoveData;
Description
contains the flags describing whether the data shall be moved instead of copied.
SourceURL
string SourceURL;
Description
contains the URL of the source of the action (e.g. the URL of a file to move).
NewTitle
string NewTitle;
Description
contains the title of the transferred object, if it is different from the original one.

If this field is filled, for example, a file will be renamed while it is being transferred.

NameClash
long NameClash;
Description
describes how to act in case of title clashes while transferring the data.

A title clash for instance occurs, if a file named "foo.txt" is to be transferred to a folder already containing another file named "foo.txt".

The value can be one of the NameClash constants.

Implementations that are not able to detect whether there is a clashing resource may ignore ERROR and RENAME always write the new data.

Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.