uk.org.ogsadai.client.toolkit.activity.delivery
Class DeliverToNull

java.lang.Object
  |
  +--uk.org.ogsadai.client.toolkit.activity.RequestComponent
        |
        +--uk.org.ogsadai.client.toolkit.activity.Activity
              |
              +--uk.org.ogsadai.client.toolkit.activity.delivery.DeliverToNull

public class DeliverToNull

extends Activity

Activity that throws away its input. This activity can be used at the end of an activity chain to turn a synchronous perform document into an asycnchronous one. It is only of use in the rare occassions where the client is not interested in obtaining the output.

This activity has one input - the data to be discarded - and no outputs.

Author:

OGSA-DAI team

Field Summary

private static java.lang.String

COPYRIGHT_NOTICE Copyright statement

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

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

Constructor Summary

DeliverToNull()
Constructs the activity.

Method Summary

protected java.lang.String	generateXML() Generates the XML representing the activity.
void	setInput(ActivityOutput input) Sets the input of this activity to be the output from another activity that will provide the data to be discarded.

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

Constructor Detail

DeliverToNull

public DeliverToNull()

Constructs the activity.

The activity providing the input data must be set using setInput.

Method Detail

setInput

public final void setInput(ActivityOutput input)

Sets the input of this activity to be the output from another activity that will provide the data to be discarded.

Parameters:

input - Output from another activity.

Throws:

java.lang.IllegalArgumentException - If input is null.

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