Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

uk.org.ogsadai.client.toolkit.activity.files
Class MoveFile

java.lang.Object
  |
  +--uk.org.ogsadai.client.toolkit.activity.RequestComponent
        |
        +--uk.org.ogsadai.client.toolkit.activity.Activity
              |
              +--uk.org.ogsadai.client.toolkit.activity.files.MoveFile
public class MoveFile
extends Activity

Moves a file.

Author:
The OGSA-DAI Team.

Field Summary
private static java.lang.String COPYRIGHT_NOTICE
          Copyright statement
private  java.lang.String mDestination
          destination path
private  java.lang.String mOrigin
          relative path of file to be moved
 
Fields inherited from class uk.org.ogsadai.client.toolkit.activity.Activity
 
Fields inherited from class uk.org.ogsadai.client.toolkit.activity.RequestComponent
 
Constructor Summary
MoveFile()
          Construct a new activity instance which moves a file.
MoveFile(java.lang.String fromPath, java.lang.String toPath)
          Construct a new activity instance which moves the given file to the specified destination.
 
Method Summary
protected  java.lang.String generateXML()
          Generates the XML representing the activity.
 java.lang.String getDestination()
          Returns the destination path where the file will be moved to.
 java.lang.String getOrigin()
          Returns the path of the file to be moved.
 void setDestination(java.lang.String path)
           
 void setOrigin(java.lang.String path)
          Set the relative path of the file to delete.
 
Methods inherited from class uk.org.ogsadai.client.toolkit.activity.Activity
addInput, addOutput, addOutputs, getDataResourceID, getInputParameters, getOutputParameters, getOutputs, replaceSpecialCharacters, setDataResourceID, setInput
 
Methods inherited from class uk.org.ogsadai.client.toolkit.activity.RequestComponent
getDataService, getName, getSession, setDataService, setSession
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COPYRIGHT_NOTICE

private static final java.lang.String COPYRIGHT_NOTICE
Copyright statement

See Also:
Constant Field Values

mOrigin

private java.lang.String mOrigin
relative path of file to be moved

mDestination

private java.lang.String mDestination
destination path

Constructor Detail

MoveFile

public MoveFile()
Construct a new activity instance which moves a file.

MoveFile

public MoveFile(java.lang.String fromPath,
                java.lang.String toPath)
Construct a new activity instance which moves the given file to the specified destination.

Parameters:
fromPath - origin of the file to be moved
toPath - destination of the file to be moved
Method Detail

setOrigin

public void setOrigin(java.lang.String path)
Set the relative path of the file to delete.

Parameters:
path - file to delete

setDestination

public void setDestination(java.lang.String path)

getOrigin

public java.lang.String getOrigin()
Returns the path of the file to be moved.

Returns:
file path

getDestination

public java.lang.String getDestination()
Returns the destination path where the file will be moved to.

Returns:
destination path

generateXML

protected java.lang.String generateXML()
Description copied from class: RequestComponent
Generates the XML representing the activity. This XML can then be inserted into a perform document that is sent to a data service.

Specified by:
generateXML in class Activity
Returns:
the XML for the activity
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD