com.edorasware.commons.core.provider.entity

Interface DomainObjectProvider<T extends EntityId,D extends EntityId,P extends Id,E extends DomainObjectDefinition<D,P>,L extends EventListener>

All Superinterfaces:

EntityProvider<P,L>, Identifiable<P>

All Known Subinterfaces:

AnyWorkObjectProvider, WorkObjectProvider<T,D,P,E,L>

All Known Implementing Classes:

BaseAnyWorkObjectProvider, BaseDomainObjectProvider, BaseWorkObjectProvider

public interface DomainObjectProvider<T extends EntityId,D extends EntityId,P extends Id,E extends DomainObjectDefinition<D,P>,L extends EventListener>
extends EntityProvider<P,L>

Represents the base entity provider interface.

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 interface com.edorasware.commons.core.provider.entity.EntityProvider

addListener, removeListener

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

getId

Method Detail

requiresInitialSynchronization

boolean requiresInitialSynchronization()

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.

Returns:

signals whether initial synchronization with the embedding system is required

getDefinitions

Collection<E> getDefinitions()

Returns all definitions known to the provider.

Returns:

the definitions

deployDefinitions

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

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

Parameters:

resources - the definition resources to deploy

deploymentName - the name under which to deploy the given resources

create

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

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.

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

Throws:

EntityNotFoundException - if the definition with the given id cannot be found

update

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

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

Parameters:

entityId - the id of the entity to update

changes - the changes to apply on the entity

Throws:

EntityNotFoundException - if the entity with the given id cannot be found

EntityUpdateFailedException - if the update of the entity with the given id fails

delete

void delete(T entityId)

Deletes the entity with the given id .

Parameters:

entityId - the id of the entity to delete

Throws:

EntityNotFoundException - if the entity with the given id cannot be found

EntityDeleteFailedException - if the delete of the entity with the given id fails