uk.org.ogsadai.client.toolkit
Interface Activity

All Known Subinterfaces:

ResourceActivity

All Known Implementing Classes:

ActivityUserErrorProducer, AddDocuments, BaseActivity, BaseCreateDataX, BaseResourceActivity, BlockCount, ByteArraysResize, ByteArraysToTuple, CalculateMean, CharArraysResize, CharArraysToDOM, CloneableObjectProducer, ControlledRepeat, Counter, CreateAnalyzer, CreateDataSink, CreateDataSource, CreateDQPResource, CreateFileIndex, CreateMapper, CreateRelationalResource, CreateResourceGroup, CreateSubCollection, CSVToTuple, DeliverToDataSink, DeliverToFTP, DeliverToNull, DeliverToRequestStatus, DeliverToSession, DeliverToSMTP, DOMToCharArrays, DQPDeliverToDataSink, DQPObtainFromDataSource, DQPPattern, Echo, ExtendedCreateRelationalResource, ExtractPhysicalSchemaToXML, ExtractTableSchema, GenericActivity, GenericTupleJoin, GenericTupleTransform, GetAvailableTables, GetDataSinkResource, GetDataSourceResource, GetDocuments, GroupBy, HashCode, Head, ListConcatenate, ListControlledRepeat, ListDirectory, ListMultiply, ListRandomSplit, ListRemove, ListSplit, LookupIndexFile, MetadataRename, ObtainFromDataSource, ObtainFromFTP, ObtainFromHTTP, ObtainFromSession, OneTupleOnly, QueryEPR, QueryRDFDB, RandomSplit, ReadFromDataSink, ReadFromFile, ReadString, RemoveDocuments, RemoveSubCollection, ReplaceWithValue, Sleep, SortedTupleListDifference, Split, SQLBag, SQLBulkLoadTuple, SQLNestedInClauseJoin, SQLNestedInClauseQuery, SQLParameterisedQuery, SQLParameterisedUpdate, SQLQuery, SQLResilient, SQLStatement, SQLUpdate, StringReplace, SummaryTupleToKMLPlacemarks, TableMetadataToXMLCharArraysList, Tee, Timestamp, ToSingleList, TupleArithmeticProject, TupleLeftOuterJoin, TupleMergeJoin, TupleProduct, TupleProjectByIDS, TupleProjection, TupleSelect, TupleSemiJoin, TupleSimpleMerge, TupleSort, TupleSplit, TupleThetaJoin, TupleToByteArrays, TupleToCSV, TupleToKMLPlacemarks, TupleToWebRowSetCharArrays, TupleUnionAll, WebRowSetCharacterDataToTuple, WriteToDataSource, XMLListCollections, XMLListResources, XPathQuery, XQuery, XSLTransform, XUpdate

public interface Activity

Base interface for an client-side activity.

Author:

The OGSA-DAI Project Team

Method Summary

ActivityName	getActivityName() Gets the activity name.
Message[]	getErrorMessages() Gets the error messages associated with the activity.
ActivityInstanceName	getInstanceName() Gets the activity instance name.
RequestAndStatusHandler	getRequestAndStatusHandler() Gets an interface through which requests can be built and request status handled.
ActivityStatus	getStatus() Gets the activity status.
Message[]	getWarnings() Gets the warnings associated with the activity.
boolean	hasErrorMessages() Gets whether or not the activity has any error messages.
boolean	hasWarnings() Gets whether not the activity has reported any warnings.
void	setActivityName(ActivityName activityName) Sets the name of the activity to invoke.

Method Detail

getActivityName

ActivityName getActivityName()

Gets the activity name.

Returns:

gets the name of the activity.

setActivityName

void setActivityName(ActivityName activityName)

Sets the name of the activity to invoke. All activity classes will have a default activity name. The method can be used to override that default.

Parameters:

activityName - Name of the activity to invoke.

getInstanceName

ActivityInstanceName getInstanceName()

Gets the activity instance name.

Returns:

activity instance name.

getStatus

ActivityStatus getStatus()

Gets the activity status. The activity status retrieved will be the last activity status obtained from the request resource. This method does not make any calls to the server.

Returns:

the activity status or null if there the activity status has not yet been obtained from the server. This would be the case if the request has not yet been passed to the server.

hasErrorMessages

boolean hasErrorMessages()

Gets whether or not the activity has any error messages.

Returns:

true if the activity has error messages, false otherwise.

getErrorMessages

Message[] getErrorMessages()

Gets the error messages associated with the activity.

Returns:

array of error messages. These error messages form a chain of error message where the first message is the highest level description of the error and the last message is the lowest level description. If there are no error messages an empty array is returned.

hasWarnings

boolean hasWarnings()

Gets whether not the activity has reported any warnings.

Returns:

true if the activity has reported warnings, false otherwise.

getWarnings

Message[] getWarnings()

Gets the warnings associated with the activity.

Returns:

array of warning messages. If there are no warnings an empty array is returned.

getRequestAndStatusHandler

RequestAndStatusHandler getRequestAndStatusHandler()

Gets an interface through which requests can be built and request status handled. This method should only be called by client side framework implementations. It should not be called by OGSA-DAI client applications.

Returns:

interface to the request and status handling methods.