org.objectweb.speedo.mim.api
Interface SpeedoAccessor

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
BasicSpeedoAccessor

public interface SpeedoAccessor
extends java.io.Serializable

This interface a state of an user instance.

Author:
S.Chassande-Barrioz

Method Summary
 void attachCopy(ProxyManager pm, java.util.Map map, SpeedoAccessor fieldsDetached, boolean makeTransactional)
           
 void deletePersistent(ProxyManager pm)
           
 void detachCopy(ProxyManager pm, java.util.Map map, SpeedoAccessor fieldsClone, java.util.Collection fgHints)
           
 byte getDetachedStatus()
          Gets the current status of this detached object
 SpeedoProxy getSpeedoProxy()
           
 long getTimeStamp()
          Version management is performed via the use of timestamps.
 boolean hasBeenFlush()
          indicates if the object has been flushed on the support in a writing before the end of the working set (commit | rollback | close).
 void jdoChangeStatus(byte action)
          Changes the status of this object
 byte jdoGetStatus()
          Gets the current status of this object
 void jdoSetStatus(byte newValue)
          Forces the new value of the status
 void loadFields(ProxyManager pm, long[] fields)
           
 void makePersistent(ProxyManager pm)
           
 void prepareWrite()
          Prepare to write (relations consistency management)
 void refresh(ProxyManager pm, java.util.Map map, java.util.Collection fgHints)
           
 void retrieve(ProxyManager pm, java.util.Map map, java.util.Collection fgHints)
           
 void setDetachedStatus(byte newValue)
          Forces the new value of the detached status
 void setFlushed(boolean val)
          Assignates a boolean value to indicate if the object has been flushed on the support in a writing before the end of the working set (commit | rollback | close).
 void setSpeedoProxy(SpeedoProxy sp)
          Assignes the SpeedoProxy attached to this state representation.
 void setTimeStamp(long ts)
           
 void workingSetClosed()
          The context has been closed (ex: transaction end).
 

Method Detail

jdoChangeStatus

public void jdoChangeStatus(byte action)
Changes the status of this object

Parameters:
action - the action that may change the status
See Also:
LifeCycle

jdoGetStatus

public byte jdoGetStatus()
Gets the current status of this object

Returns:
the current state in the life cycle
See Also:
LifeCycle

jdoSetStatus

public void jdoSetStatus(byte newValue)
Forces the new value of the status

Parameters:
newValue - the new status of this object
See Also:
LifeCycle

getTimeStamp

public long getTimeStamp()
Version management is performed via the use of timestamps.


setTimeStamp

public void setTimeStamp(long ts)

getDetachedStatus

public byte getDetachedStatus()
Gets the current status of this detached object

Returns:
the current state in the life cycle

setDetachedStatus

public void setDetachedStatus(byte newValue)
Forces the new value of the detached status

Parameters:
newValue - the new status of this object

getSpeedoProxy

public SpeedoProxy getSpeedoProxy()
Returns:
The SpeedoProxy attached to this state representation.

setSpeedoProxy

public void setSpeedoProxy(SpeedoProxy sp)
Assignes the SpeedoProxy attached to this state representation.


prepareWrite

public void prepareWrite()
Prepare to write (relations consistency management)


workingSetClosed

public void workingSetClosed()
The context has been closed (ex: transaction end).


hasBeenFlush

public boolean hasBeenFlush()
indicates if the object has been flushed on the support in a writing before the end of the working set (commit | rollback | close).


setFlushed

public void setFlushed(boolean val)
Assignates a boolean value to indicate if the object has been flushed on the support in a writing before the end of the working set (commit | rollback | close).

Parameters:
val - is the boolean which must be assigned.

makePersistent

public void makePersistent(ProxyManager pm)

deletePersistent

public void deletePersistent(ProxyManager pm)

loadFields

public void loadFields(ProxyManager pm,
                       long[] fields)

detachCopy

public void detachCopy(ProxyManager pm,
                       java.util.Map map,
                       SpeedoAccessor fieldsClone,
                       java.util.Collection fgHints)

attachCopy

public void attachCopy(ProxyManager pm,
                       java.util.Map map,
                       SpeedoAccessor fieldsDetached,
                       boolean makeTransactional)

refresh

public void refresh(ProxyManager pm,
                    java.util.Map map,
                    java.util.Collection fgHints)

retrieve

public void retrieve(ProxyManager pm,
                     java.util.Map map,
                     java.util.Collection fgHints)