com.scaleoutsoftware.soss.client

Class SossObjectDescriptor

java.lang.Object

com.scaleoutsoftware.soss.client.SossObjectDescriptor

All Implemented Interfaces:

java.io.Serializable

public final class SossObjectDescriptor
extends java.lang.Object
implements java.io.Serializable

Contains information necessary to insert an object into a NamedCache via a bulk NamedCache.putAll(java.util.Map) operation.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SossObjectDescriptor(java.io.Serializable object, CreatePolicy policy, ObjectMetadata metadata) Creates a SossObjDescriptor class with the metadata and CreatePolicy information needed to insert an object via a bulk put NamedCache.putAll(java.util.Map) operation.

Method Summary

Modifier and Type	Method and Description
java.lang.Exception	getInsertException() Gets the exception encountered by a bulk add operation, or null if the object was added to the NamedCache successfully.
ObjectMetadata	getMetadata() Gets metadata related to the object being inserted.
java.io.Serializable	getObject() Gets the serializable object to insert into the NamedCache.
CreatePolicy	getPolicy() Policy information for the object being inserted.
void	setMetadata(ObjectMetadata metadata)
void	setObject(java.io.Serializable object)
void	setPolicy(CreatePolicy policy)

Methods inherited from class java.lang.Object

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

Constructor Detail

SossObjectDescriptor

public SossObjectDescriptor(java.io.Serializable object,
                            CreatePolicy policy,
                            ObjectMetadata metadata)

Creates a SossObjDescriptor class with the metadata and CreatePolicy information needed to insert an object via a bulk put NamedCache.putAll(java.util.Map) operation.

Parameters:

object - Object to insert into the NamedCache.

policy - Policy information for the object being inserted.

metadata - Metadata related to the object being inserted.

Method Detail

getObject

public java.io.Serializable getObject()

Gets the serializable object to insert into the NamedCache.

Returns:

Serializable value

setObject

public void setObject(java.io.Serializable object)

Parameters:

object - Serializable value

See Also:

getObject()

getMetadata

public ObjectMetadata getMetadata()

Gets metadata related to the object being inserted.

Returns:

Metadata value

setMetadata

public void setMetadata(ObjectMetadata metadata)

Parameters:

metadata - Metadata value

See Also:

getMetadata()

getPolicy

public CreatePolicy getPolicy()

Policy information for the object being inserted.

Returns:

CreatePolicy value

setPolicy

public void setPolicy(CreatePolicy policy)

Parameters:

policy - CreatePolicy value

See Also:

getPolicy()

getInsertException

public java.lang.Exception getInsertException()

Gets the exception encountered by a bulk add operation, or null if the object was added to the NamedCache successfully. This property can be checked after a NamedCache.add() call to see if the corresponding object was inserted.

Returns:

Exception value