ostore.client
Class OSResult

java.lang.Object
  |
  +--ostore.client.OSResult

All Implemented Interfaces:

QueueElementIF, QuickSerializable

Direct Known Subclasses:

OSCloseReplicaResult, OSCreateObjectResult, OSMetadataResult, OSOpenReplicaResult, OSReadResult, OSRegisterAppResult, OSUpdateResult, OSVIDResult

public abstract class OSResult

extends Object

implements QuickSerializable, QueueElementIF

The OSResult is the abstract super class for all OceanStore API results. The ClientStage translates the systems result message into an OSResult that is passed back to the application. The OSResult records the sequence number of the originating OSRequest so that an application can determine the request that produced this result.

Version:

$Id: OSResult.java,v 1.16 2002/07/22 20:54:53 srhea Exp $

Author:

Patrick R. Eaton

See Also:

OSRequest

Field Summary

OSAppId

app_id

Method Summary

OSAppId	getAppId() Returns the OSAppId that identifies the requesting application.
Long	getReqSeqNum() Returns the sequence number of the request that generated this result.
QuickSerializable	getUserTag() Returns the user tag.
void	serialize(OutputBuffer buffer) Add the object to the buffer.

Methods inherited from class java.lang.Object

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

Field Detail

app_id

public OSAppId app_id

Method Detail

serialize

public void serialize(OutputBuffer buffer)

Description copied from interface: QuickSerializable

Add the object to the buffer.

Specified by:

serialize in interface QuickSerializable

Parameters:

buffer - the output buffer to add the object to

getAppId

public OSAppId getAppId()

Returns the OSAppId that identifies the requesting application.

Returns:

the OSAppId to identify the requesting application

getUserTag

public QuickSerializable getUserTag()

Returns the user tag. The user tag is an application-defined object that can be used for any purpose the application desires. The user tag is copied from the corresponding OSRequest.

Returns:

the user tag attached to the result

getReqSeqNum

public Long getReqSeqNum()

Returns the sequence number of the request that generated this result. This allows the applications to corelate requests and responses.

Returns:

the sequence number of the request that generated this result