org.apache.oodt.commons.activity

Class Activity

java.lang.Object

org.apache.oodt.commons.activity.Activity

Direct Known Subclasses:

CompositeActivity, NullActivity

public abstract class Activity
extends Object

An activity is an occurrence of some active action. It has a unique ID in the universe, a way to log incidents that occur during the course of the activity, and a way to indicate that the activity has stopped.

Version:

$Revision: 1.2 $

Author:

Kelly

Field Summary

Fields

Modifier and Type	Field and Description
protected String	id Unique ID of the activity.
static int	INT
static int	INT1

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Activity() Creates a new Activity instance.

Method Summary

Modifier and Type	Method and Description
String	getID() Get the activity's ID.
void	log(Incident incident) Log the given incident.
protected abstract void	recordIncident(Incident incident) Record the given incident.
void	setID(String id) Change the activity's ID to the given value.
void	stop() Stop this activity.

Methods inherited from class java.lang.Object

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

Field Detail

INT

public static final int INT

See Also:

Constant Field Values

INT1

public static final int INT1

See Also:

Constant Field Values

id

protected String id

Unique ID of the activity.

Constructor Detail

Activity

protected Activity()

Creates a new Activity instance.

Method Detail

setID

public void setID(String id)

Change the activity's ID to the given value.

Parameters:

id - New ID.

getID

public String getID()

Get the activity's ID.

Returns:

a String ID.

stop

public void stop()

Stop this activity. This method logs a ActivityStopped incident. No further incidents may be logged after calling this method.

log

public final void log(Incident incident)

Log the given incident.

Parameters:

incident - The incident to log.

recordIncident

protected abstract void recordIncident(Incident incident)

Record the given incident.

Parameters:

incident - an Incident value.