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

java.lang.Object
  |
  +--uk.org.ogsadai.client.toolkit.activity.RequestComponent
        |
        +--uk.org.ogsadai.client.toolkit.activity.Activity
              |
              +--uk.org.ogsadai.client.toolkit.activity.files.DeleteFile

public class DeleteFile

extends Activity

Deletes a file.

Author:

The OGSA-DAI Team.

Field Summary

private static java.lang.String	COPYRIGHT_NOTICE Copyright statement
private java.lang.String	mPath relative path file to delete

Fields inherited from class uk.org.ogsadai.client.toolkit.activity.Activity

Fields inherited from class uk.org.ogsadai.client.toolkit.activity.RequestComponent

Constructor Summary

DeleteFile(java.lang.String path)
Construct a new activity instance which deletes the given file.

Method Summary

protected java.lang.String	generateXML() Generates the XML representing the activity.
java.lang.String	getPath() Returns the path of the file to delete, relative to the root directory of the data resource
void	setPath(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

mPath

private java.lang.String mPath

relative path file to delete

Constructor Detail

DeleteFile

public DeleteFile(java.lang.String path)

Construct a new activity instance which deletes the given file.

Parameters:

path - file to delete, relative to the root directory of the file system data resource

Method Detail

setPath

public void setPath(java.lang.String path)

Set the relative path of the file to delete.

Parameters:

path - file to delete

getPath

public java.lang.String getPath()

Returns the path of the file to delete, relative to the root directory of the data resource

Returns:

path of the file to delete

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