uk.org.ogsadai.client.toolkit.activity.resource
Class RemoveDataServiceResource

java.lang.Object
  |
  +--uk.org.ogsadai.client.toolkit.activity.RequestComponent
        |
        +--uk.org.ogsadai.client.toolkit.activity.Activity
              |
              +--uk.org.ogsadai.client.toolkit.activity.resource.RemoveDataServiceResource

public class RemoveDataServiceResource

extends Activity

Withdraws a data service resource from a service. The resource is removed from the service's persistent data service resource file. Configuration files for the resource may be deleted optionally.

This activity has one output - the name of the resource removed.

Author:

The OGSA-DAI Project Team

Field Summary

private static java.lang.String	COPYRIGHT_NOTICE Copyright statement
private boolean	mRemoveConfiguration Flag indicating if configuration files are to be removed
private java.lang.String	mResourceName Name of resource to remove

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

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

Constructor Summary

RemoveDataServiceResource()
Constructs a new activity object and registers one output for this activity.

Method Summary

protected java.lang.String	generateXML() Generates the XML representing the activity.
ActivityOutput	getOutput() Gets the activity's only output - the name of the resource removed.
void	removeConfigurationFiles(boolean remove) Specify whether the configuration files of the data resource are to be removed.
void	setResourceName(java.lang.String resourceName) Set the name of the resource to be removed.

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

mResourceName

private java.lang.String mResourceName

Name of resource to remove

mRemoveConfiguration

private boolean mRemoveConfiguration

Flag indicating if configuration files are to be removed

Constructor Detail

RemoveDataServiceResource

public RemoveDataServiceResource()

Constructs a new activity object and registers one output for this activity.

Method Detail

setResourceName

public void setResourceName(java.lang.String resourceName)

Set the name of the resource to be removed.

Parameters:

resourceName - Data service resource name

Throws:

java.lang.IllegalArgumentException - If resourceName is null.

removeConfigurationFiles

public void removeConfigurationFiles(boolean remove)

Specify whether the configuration files of the data resource are to be removed.

Parameters:

remove - if true configuration files will be removed at the server.

getOutput

public ActivityOutput getOutput()

Gets the activity's only output - the name of the resource removed.

Returns:

the activity output.

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