com.scaleoutsoftware.soss.client.da

Class ReadMetadataResult

java.lang.Object

com.scaleoutsoftware.soss.client.da.ReadMetadataResult

public class ReadMetadataResult
extends java.lang.Object

An object containing both a StateServerResult status value indicating the success/failure mode of a DataAccessor.readMetadata(java.util.Set<com.scaleoutsoftware.soss.client.da.ReadOptions>) operation and any metadata read from the StateServer.

Unless the ReadOptions.ObjectMayNotExist flag or the ReadOptions.ObjectMayBeLocked flag is specified via the ReadOptions parameter to DataAccessor.readMetadata(java.util.Set<com.scaleoutsoftware.soss.client.da.ReadOptions>), the value StateServerResult.Success will always be returned via the getStatus() method of the ReadMetadataResult. Any errors will result in exceptions.

Method Summary

Modifier and Type	Method and Description
ExtendedObjectMetadata	getMetadata() If Status is StateServerResult.Success return the metadata read from the StateServer.
StateServerResult	getStatus() Returns the StateServerResult value indicating whether the DataAccessor.readMetadata(java.util.Set<com.scaleoutsoftware.soss.client.da.ReadOptions>) operation completed successfully or whether any expected errors were encountered.
boolean	isStale()

Methods inherited from class java.lang.Object

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

Method Detail

getStatus

public StateServerResult getStatus()

Returns the StateServerResult value indicating whether the DataAccessor.readMetadata(java.util.Set<com.scaleoutsoftware.soss.client.da.ReadOptions>) operation completed successfully or whether any expected errors were encountered.

Returns:

the StateServerResult value indicating the status of a DataAccessor.readMetadata(java.util.Set<com.scaleoutsoftware.soss.client.da.ReadOptions>) request

getMetadata

public ExtendedObjectMetadata getMetadata()

If Status is StateServerResult.Success return the metadata read from the StateServer. Otherwise, return null.

Returns:

the metadata read from the StateServer. Or, null if an expected exception occurred. In the latter case, getStatus() will return something other than StateServerResult.Success.

isStale

public boolean isStale()