org.ogf.saga
Interface SagaObject

All Superinterfaces:

Cloneable

All Known Subinterfaces:

Buffer, Context, Directory, Discoverer, EntityData, EntityDataSet, File, IOVec, Job, JobDescription, JobSelf, JobService, LogicalDirectory, LogicalFile, Metric, NSDirectory, NSEntry, Parameter, RPC, ServiceData, ServiceDescription, Session, Stream, StreamServer, Task<T,E>, TaskContainer, URL

All Known Implementing Classes:

FileInputStream, FileOutputStream, StreamInputStream, StreamOutputStream

public interface SagaObject
extends Cloneable

This is the base for all SAGA objects. Deviation from the SAGA specs: we don't want to call this "Object" because that might cause some confusion in Java. All SAGA objects must support the clone() method, so this interface extends Cloneable.

Field Summary

static float	NO_WAIT Timeout constant: don't wait.
static float	WAIT_FOREVER Timeout constant: wait forever.

Method Summary

Object	clone() Copies the Saga object.
String	getId() Returns the object id of this SAGA object.
Session	getSession() Returns a shallow copy of the session from which this object was created.

Field Detail

WAIT_FOREVER

static final float WAIT_FOREVER

Timeout constant: wait forever.

See Also:

Constant Field Values

NO_WAIT

static final float NO_WAIT

Timeout constant: don't wait.

See Also:

Constant Field Values

Method Detail

getSession

Session getSession()
                   throws DoesNotExistException

Returns a shallow copy of the session from which this object was created.

Returns:

the session.

Throws:

DoesNotExistException - is thrown when this method is called on objects that do not have a session attached.

getId

String getId()

Returns the object id of this SAGA object. Note: java.util.UUID could be used for this. See Sun's comments on UUID generation.

Returns:

the object id.

clone

Object clone()
             throws CloneNotSupportedException

Copies the Saga object.

Returns:

the clone.

Throws:

CloneNotSupportedException - when the clone method is not supported.