org.nees.data.service
Class UploadOptions

java.lang.Object
  extended byorg.nees.data.service.TransferOptions
      extended byorg.nees.data.service.UploadOptions
All Implemented Interfaces:
java.io.Serializable

public class UploadOptions
extends TransferOptions

This class contains the options that dictate how the server does an upload.

Lifecycle

The application creates this with the appropriate properties.

Usage

Instances are sent to the service as part of a upload request.

Property Summary
append boolean if the file exists, then the requested upload is appended to it. If the file does not exist, then it is created.
localFileName String Used only in conjunction with the protocol file, this is used to locate the file. This requires the fully qualified path name. This is ignored if any other protocol is used.
newFIle boolean set this to true when the application insists that the file does not exist on the server. This will cause the upload request to fail if the logical name for this file is already in use.
newVersion boolean setting this true tells the server to keep the current file, making a new version of it and replacing it with the uploaded file. If the append flag is enabled, then a new version is created by appending the newly uploaded file.

See Also:
Serialized Form

Constructor Summary
UploadOptions()
           
UploadOptions(java.lang.String protocol)
           
 
Method Summary
 boolean isAppend()
           
 boolean isNewFile()
           
 boolean isNewVersion()
           
 void setAppend(boolean isAppend)
           
 void setNewFile(boolean newFile)
           
 void setNewVersion(boolean newVersion)
           
 java.lang.String toString()
          This issues a report on the content of this class.
 
Methods inherited from class org.nees.data.service.TransferOptions
getLocalFileName, getProtocol, setLocalFileName, setProtocol
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

UploadOptions

public UploadOptions(java.lang.String protocol)

UploadOptions

public UploadOptions()
Method Detail

setNewFile

public void setNewFile(boolean newFile)

isNewFile

public boolean isNewFile()

isAppend

public boolean isAppend()

setAppend

public void setAppend(boolean isAppend)

isNewVersion

public boolean isNewVersion()

setNewVersion

public void setNewVersion(boolean newVersion)

toString

public java.lang.String toString()
This issues a report on the content of this class. This is intended for debugging and does not appear in the generated class.

Overrides:
toString in class TransferOptions