org.apache.polygene.spi.entitystore

Interface EntityStoreUnitOfWork

All Known Implementing Classes:

DefaultEntityStoreUnitOfWork

public interface EntityStoreUnitOfWork

EntityStore UnitOfWork.

Method Summary

Modifier and Type	Method and Description
StateCommitter	applyChanges()
Instant	currentTime()
void	discard()
EntityState	entityStateOf(ModuleDescriptor module, EntityReference anIdentity) Get the EntityState for a given reference.
Identity	identity()
ModuleDescriptor	module()
EntityState	newEntityState(EntityReference anIdentity, EntityDescriptor entityDescriptor) Create new EntityState for a given reference.
Usecase	usecase()
String	versionOf(EntityReference anIdentity)

Method Detail

identity

Identity identity()

currentTime

Instant currentTime()

newEntityState

EntityState newEntityState(EntityReference anIdentity,
                           EntityDescriptor entityDescriptor)
                    throws EntityStoreException

Create new EntityState for a given reference.

This should only create the EntityState and not insert it into any database, since that should occur during the applyChanges() call.

Parameters:

anIdentity - the reference of the entity

entityDescriptor - entity descriptor

Returns:

The new entity state.

Throws:

EntityStoreException - Thrown if creational fails.

entityStateOf

EntityState entityStateOf(ModuleDescriptor module,
                          EntityReference anIdentity)
                   throws EntityStoreException,
                          EntityNotFoundException

Get the EntityState for a given reference. Throws EntityNotFoundException if the entity with given anIdentity is not found.

Parameters:

module - Module descriptor

anIdentity - The entity reference. This argument must not be null.

Returns:

Entity state given the composite descriptor and reference.

Throws:

EntityStoreException - thrown if retrieval failed.

EntityNotFoundException - if requested entity does not exist

versionOf

String versionOf(EntityReference anIdentity)
          throws EntityStoreException

Throws:

EntityStoreException

applyChanges

StateCommitter applyChanges()
                     throws EntityStoreException

Throws:

EntityStoreException

discard

void discard()

usecase

Usecase usecase()

module

ModuleDescriptor module()