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

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

public class XMLRemoveCollection

extends Activity

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

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

<removedCollection name="someCollection"/>

Author:

The OGSA-DAI Project Team

Field Summary

private static java.lang.String	COPYRIGHT_NOTICE Copyright statement
private java.lang.String	mCollectionName Collection name
private java.lang.String	mParentCollectionName Parent Collection 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

XMLRemoveCollection()
Constructs a request to remove a collection.

XMLRemoveCollection(java.lang.String collectionName)
Constructs a request to remove a collection.

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

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

mCollectionName

private java.lang.String mCollectionName

Collection name

mParentCollectionName

private java.lang.String mParentCollectionName

Parent Collection name

Constructor Detail

XMLRemoveCollection

public XMLRemoveCollection()

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

XMLRemoveCollection

public XMLRemoveCollection(java.lang.String collectionName)

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

Parameters:

collectionName - Name of collection to be removed.

Throws:

java.lang.IllegalArgumentException - If collectionName is null.

Method Detail

setCollectionName

public void setCollectionName(java.lang.String collectionName)

Set the name of the collection to be removed.

Parameters:

collectionName - Name of collection to be removed.

Throws:

java.lang.IllegalArgumentException - If collectionName is null.

setParentCollectionName

public void setParentCollectionName(java.lang.String parentCollectionName)

Set the parent collection name. The collection will be removed from this collection. If this is set to null then the collection 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