com.edorasware.commons.core.provider.entity

Class BaseDomainObjectProvider<T extends EntityId,D extends EntityId,P extends Id,E extends DomainObjectDefinition<D,P>,L extends EventListener,M extends DomainObjectManager<T,D,P,?,?,?,?,?,?,?>>

java.lang.Object

com.edorasware.commons.core.provider.entity.BaseEntityProvider<P,L,M>

com.edorasware.commons.core.provider.entity.BaseDomainObjectProvider<T,D,P,E,L,M>

All Implemented Interfaces:

Identifiable<P>, DomainObjectProvider<T,D,P,E,L>, EntityProvider<P,L>

Direct Known Subclasses:

BaseWorkObjectProvider

public abstract class BaseDomainObjectProvider<T extends EntityId,D extends EntityId,P extends Id,E extends DomainObjectDefinition<D,P>,L extends EventListener,M extends DomainObjectManager<T,D,P,?,?,?,?,?,?,?>>
extends BaseEntityProvider<P,L,M>
implements DomainObjectProvider<T,D,P,E,L>

Base class for provider implementations.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseDomainObjectProvider(M manager, P id, boolean requiresInitialSynchronization, TimeProvider timeProvider)
protected	BaseDomainObjectProvider(M manager, P id, TimeProvider timeProvider)
protected	BaseDomainObjectProvider(M manager, TimeProvider timeProvider)

Method Summary

Modifier and Type	Method and Description
T	create(D definitionId, Map<String,Object> variables) Creates a new entity based on the given definition and instance-specific variables.
void	delete(T entityId) Deletes the entity with the given id .
void	deployDefinitions(List<? extends org.springframework.core.io.Resource> resources, String deploymentName) Deploys the given definition resources.
Collection<E>	getDefinitions() Returns all definitions known to the provider.
boolean	requiresInitialSynchronization() Returns whether the provider requires initial synchronization of its data with the system that the provider is embedded in.
void	update(T entityId, List<FieldChange> changes) Updates the entity with the given id by applying the submitted changes.

Methods inherited from class com.edorasware.commons.core.provider.entity.BaseEntityProvider

addListener, execute, getId, getTimeProvider, removeListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.edorasware.commons.core.provider.entity.EntityProvider

addListener, removeListener

Methods inherited from interface com.edorasware.commons.core.id.Identifiable

getId

Constructor Detail

BaseDomainObjectProvider

protected BaseDomainObjectProvider(M manager,
                                   TimeProvider timeProvider)

BaseDomainObjectProvider

protected BaseDomainObjectProvider(M manager,
                                   P id,
                                   TimeProvider timeProvider)

BaseDomainObjectProvider

protected BaseDomainObjectProvider(M manager,
                                   P id,
                                   boolean requiresInitialSynchronization,
                                   TimeProvider timeProvider)

Method Detail

requiresInitialSynchronization

public boolean requiresInitialSynchronization()

Description copied from interface: DomainObjectProvider

Returns whether the provider requires initial synchronization of its data with the system that the provider is embedded in. It is recommended to turn off this flag if the provider and the embedding system are always in sync through listener notifications.

Specified by:

requiresInitialSynchronization in interface DomainObjectProvider<T extends EntityId,D extends EntityId,P extends Id,E extends DomainObjectDefinition<D,P>,L extends EventListener>

Returns:

signals whether initial synchronization with the embedding system is required

getDefinitions

public Collection<E> getDefinitions()

Description copied from interface: DomainObjectProvider

Returns all definitions known to the provider.

Specified by:

getDefinitions in interface DomainObjectProvider<T extends EntityId,D extends EntityId,P extends Id,E extends DomainObjectDefinition<D,P>,L extends EventListener>

Returns:

the definitions

deployDefinitions

public void deployDefinitions(List<? extends org.springframework.core.io.Resource> resources,
                              String deploymentName)

Description copied from interface: DomainObjectProvider

Deploys the given definition resources. Typically, the implementation creates definition instances based on the given resources and notifies the provider listeners.

Specified by:

deployDefinitions in interface DomainObjectProvider<T extends EntityId,D extends EntityId,P extends Id,E extends DomainObjectDefinition<D,P>,L extends EventListener>

Parameters:

resources - the definition resources to deploy

deploymentName - the name under which to deploy the given resources

create

public T create(D definitionId,
                Map<String,Object> variables)

Description copied from interface: DomainObjectProvider

Creates a new entity based on the given definition and instance-specific variables. Typically, the given variables are used to build the initial data set of the entity that is created. Multiple entities based on the same definition can be created at the same time. Each created entity can be uniquely identified by its id.

Specified by:

create in interface DomainObjectProvider<T extends EntityId,D extends EntityId,P extends Id,E extends DomainObjectDefinition<D,P>,L extends EventListener>

Parameters:

definitionId - the definition id of the entity to create

variables - the instance-specific variables to apply when creating the entity

Returns:

the unique id of the created entity

update

public void update(T entityId,
                   List<FieldChange> changes)

Description copied from interface: DomainObjectProvider

Updates the entity with the given id by applying the submitted changes.

Specified by:

update in interface DomainObjectProvider<T extends EntityId,D extends EntityId,P extends Id,E extends DomainObjectDefinition<D,P>,L extends EventListener>

Parameters:

entityId - the id of the entity to update

changes - the changes to apply on the entity

delete

public void delete(T entityId)

Description copied from interface: DomainObjectProvider

Deletes the entity with the given id .

Specified by:

delete in interface DomainObjectProvider<T extends EntityId,D extends EntityId,P extends Id,E extends DomainObjectDefinition<D,P>,L extends EventListener>

Parameters:

entityId - the id of the entity to delete