uk.org.ogsadai.client.toolkit.activity.xmldb
Class XMLRemoveResource

java.lang.Object
  |
  +--uk.org.ogsadai.client.toolkit.activity.RequestComponent
        |
        +--uk.org.ogsadai.client.toolkit.activity.Activity
              |
              +--uk.org.ogsadai.client.toolkit.activity.xmldb.XMLRemoveResource

public class XMLRemoveResource

extends Activity

This activity removes a resource from an XML database collection exposed by a data service resource.

It has no input and one output - the name of the resource removed. The format of the output is OGSA-DAI specific XML. For example:

<removedResource name="someResource"/>

Author:

The OGSA-DAI Project Team

Field Summary

private static java.lang.String	COPYRIGHT_NOTICE Copyright statement
private java.lang.String	mParentCollectionName Parent Collection name
private java.lang.String	mResourceName Resource name

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

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

Constructor Summary

XMLRemoveResource()
Constructs a request to remove a resource.

XMLRemoveResource(java.lang.String resourceName)
Constructs a request to remove a resource.

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 removed collection.
void	setParentCollectionName(java.lang.String parentCollectionName) Set the parent collection name.
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

Resource name

mParentCollectionName

private java.lang.String mParentCollectionName

Parent Collection name

Constructor Detail

XMLRemoveResource

public XMLRemoveResource()

Constructs a request to remove a resource. The resource will be removed from the base collection. The resource must be set using setResourceName.

XMLRemoveResource

public XMLRemoveResource(java.lang.String resourceName)

Constructs a request to remove a resource. The resource will be removed from the base collection.

Parameters:

resourceName - Name of resource to be removed.

Throws:

java.lang.IllegalArgumentException - If resourceName is null.

Method Detail

setResourceName

public void setResourceName(java.lang.String resourceName)

Set the name of the resource to be removed.

Parameters:

resourceName - Name of resource to be removed.

Throws:

java.lang.IllegalArgumentException - If resourceName is null.

setParentCollectionName

public void setParentCollectionName(java.lang.String parentCollectionName)

Set the parent collection name. The resource will be removed from this collection. If this is set to null then the resource will be removed from the base collection.

Parameters:

parentCollectionName - The name of the collection or null.

getOutput

public ActivityOutput getOutput()

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

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