ActivityOutput (OGSA-DAI -- (c) International Business Machines Corporation, 2002-2006, The University of Edinburgh, 2002-2006)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

uk.org.ogsadai.client.toolkit.activity
Class ActivityOutput

java.lang.Object
  |
  +--uk.org.ogsadai.client.toolkit.activity.ActivityOutput

public final class ActivityOutput
extends java.lang.Object

Client-side representation of activity output.

Provides a means of connecting activities in a request and also of accessing the data output by an activity when the request is executed by a service.

Author:: The OGSA-DAI Project Team

Field Summary
`private static java.lang.String`	`COPYRIGHT_NOTICE` Copyright statement
`private java.lang.String`	`mData` Output data as obtained from response document.
`private java.lang.String`	`mName` Unique name of the output.
`protected boolean`	`mProcessed` Indicates whether data has been processed into this output.

Constructor Summary
`ActivityOutput()` Constructs an activity output with a unique name.

Method Summary
`java.lang.String`	`getData()` Gets the output data as a string.
`java.lang.String`	`getName()` Gets the unique name of this activity output.
`boolean`	`hasData()` Gets whether data is available for this output.
`(package private) void`	`setData(java.lang.String data)` Sets the output data that will be available from the `getData` method.
`java.lang.String`	`toString()` Returns a brief description of this activity output.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

COPYRIGHT_NOTICE

private static final java.lang.String COPYRIGHT_NOTICE

See Also:: Constant Field Values

mName

private java.lang.String mName

Unique name of the output.

mData

private java.lang.String mData

Output data as obtained from response document.

mProcessed

protected boolean mProcessed

Indicates whether data has been processed into this output.

Constructor Detail

ActivityOutput

public ActivityOutput()

Constructs an activity output with a unique name.

Method Detail

getName

public java.lang.String getName()

Gets the unique name of this activity output.

Returns:: activity output name

hasData

public boolean hasData()

Gets whether data is available for this output.

Returns:: true if data is available, false otherwise.

getData

public java.lang.String getData()
                         throws NoActivityOutputException

Gets the output data as a string.

Returns:: string containing the output data
Throws:: NoActivityOutputException - if there is no output data or the data has not yet been processed to this output or the activity that generates this output has not yet been executed.

toString

public java.lang.String toString()

Returns a brief description of this activity output. The exact details are subject to change but at present the description is of the form:
"[ActivityOutput: name=f83af69893 data chars=124 ]"

Overrides:: toString in class java.lang.Object

Returns:: brief description of the activity object

setData

void setData(java.lang.String data)

Sets the output data that will be available from the getData method.

Parameters:: data - Output data as contained in a response document from a service.