Top Description Fields Constructors Methods
org.eclipse.persistence.internal.sessions.remote

public Class Transporter

extends Object
implements Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable
Imports
java.io.Serializable, java.util.Map, org.eclipse.persistence.internal.helper.Helper, org.eclipse.persistence.internal.sessions.AbstractSession, org.eclipse.persistence.queries.DatabaseQuery
As the name signifies the object is responsible for carrying read objects from the server to the client.

Field Summary

Modifier and TypeField and Description
public Object
object

Object(s) read from the server

protected Map<Object, ObjectDescriptor>
objectDescriptors

protected DatabaseQuery
query

public boolean
wasOperationSuccessful

Constructor Summary

AccessConstructor and Description
public
Transporter()

public
Transporter(Object object)

Method Summary

Modifier and TypeMethod and Description
public void
expand(AbstractSession session)

Deserialize the object.

public RuntimeException

Returns:

java.lang.RuntimeException
getException()

Return the exception which this Transporter is holding.

public Object
getObject()

Returns the read object(s) from the server side.

public Map<Object, ObjectDescriptor>
getObjectDescriptors()

Returns a hashtable of object descriptors.

public DatabaseQuery

Returns:

org.eclipse.persistence.queries.DatabaseQuery
getQuery()

Return the query associated with this transporter.

public void
prepare(AbstractSession session)

Serialize the object.

public void
setException(RuntimeException exception)

Set the exception associated with this Transporter

public void
setObject(Object object)

Set the read object(s) from the server side.

public void
setObjectDescriptors(Map<Object, ObjectDescriptor> objectDescriptors)

Get object to object descriptor

public void
setQuery(DatabaseQuery query)

Set the query associated with this transporter

public void
setWasOperationSuccessful(boolean wasOperationSuccessful)

Set whether the operation which caused this transporter to be returned was successful.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
public boolean

Returns:

boolean
wasOperationSuccessful()

Return whether the operation which caused this transporter to be returned was successful.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

objectback to summary
public Object object

Object(s) read from the server

objectDescriptorsback to summary
protected Map<Object, ObjectDescriptor> objectDescriptors
queryback to summary
protected DatabaseQuery query
wasOperationSuccessfulback to summary
public boolean wasOperationSuccessful

Constructor Detail

Transporterback to summary
public Transporter()
Transporterback to summary
public Transporter(Object object)

Method Detail

expandback to summary
public void expand(AbstractSession session)

Deserialize the object.

getExceptionback to summary
public RuntimeException getException()

Return the exception which this Transporter is holding. An exception will only be returned when the operation that returned this transporter was not successful.

Returns:RuntimeException

java.lang.RuntimeException

getObjectback to summary
public Object getObject()

Returns the read object(s) from the server side.

getObjectDescriptorsback to summary
public Map<Object, ObjectDescriptor> getObjectDescriptors()

Returns a hashtable of object descriptors.

getQueryback to summary
public DatabaseQuery getQuery()

Return the query associated with this transporter.

Returns:DatabaseQuery

org.eclipse.persistence.queries.DatabaseQuery

prepareback to summary
public void prepare(AbstractSession session)

Serialize the object.

setExceptionback to summary
public void setException(RuntimeException exception)

Set the exception associated with this Transporter

setObjectback to summary
public void setObject(Object object)

Set the read object(s) from the server side.

setObjectDescriptorsback to summary
public void setObjectDescriptors(Map<Object, ObjectDescriptor> objectDescriptors)

Get object to object descriptor

setQueryback to summary
public void setQuery(DatabaseQuery query)

Set the query associated with this transporter

setWasOperationSuccessfulback to summary
public void setWasOperationSuccessful(boolean wasOperationSuccessful)

Set whether the operation which caused this transporter to be returned was successful.

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override
wasOperationSuccessfulback to summary
public boolean wasOperationSuccessful()

Return whether the operation which caused this transporter to be returned was successful.

Returns:boolean

boolean