com.arjuna.mw.wsas.activity

Interface ActivityHandle

All Known Implementing Classes:

ActivityHandleImple

public interface ActivityHandle

ActivityHandle is used as a representation of a single activity when it is suspended from a running thread and may be later resumed. The implementation of the token can be as lightweight as required by the underlying implementation in order that it can uniquely represent all activity instances. Since this is a client-facing class, it is unlikely that the application user will typically want to see the entire activity context in order to simply suspend it from the thread.

Since:

1.0.

Version:

$Id: ActivityHandle.java,v 1.1 2002/11/25 10:51:40 nmcl Exp $

Author:

Mark Little (mark.little@arjuna.com)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Although users won't typically care what the underlying implementation of a context is, they will need to do comparisons.
int	getTimeout()
int	hashCode() Although users won't typically care what the underlying implementation of a context is, they will need to do comparisons.
String	tid()
boolean	valid()

Method Detail

getTimeout

int getTimeout()

Returns:

the timeout associated with this activity.

equals

boolean equals(Object obj)

Although users won't typically care what the underlying implementation of a context is, they will need to do comparisons. So, although this method is provided by Java.Object we have it here to ensure that we don't forget to implement it! Two instances are equal if the refer to the same transaction.

Overrides:

equals in class Object

Returns:

true if the two objects are the same, false otherwise.

hashCode

int hashCode()

Although users won't typically care what the underlying implementation of a context is, they will need to do comparisons. So, although this method is provided by Java.Object we have it here to ensure that we don't forget to implement it!

Overrides:

hashCode in class Object

Returns:

the hash value for the target.

valid

boolean valid()

Returns:

whether or not this is a valid handle.

tid

String tid()

Returns:

the unique activity identifier.