com.edorasware.commons.core.provider.entity

Class BaseDomainObjectProvider

java.lang.Object

com.edorasware.commons.core.provider.entity.BaseEntityProvider<AnyWorkObjectProviderListener,AnyWorkObjectManager>

com.edorasware.commons.core.provider.entity.BaseDomainObjectProvider

All Implemented Interfaces:

Identifiable, DomainObjectProvider, EntityProvider<AnyWorkObjectProviderListener>

Direct Known Subclasses:

BaseWorkObjectProvider

public abstract class BaseDomainObjectProvider
extends BaseEntityProvider<AnyWorkObjectProviderListener,AnyWorkObjectManager>
implements DomainObjectProvider

Base class for provider implementations.

Method Summary

Modifier and Type	Method and Description
String	create(AnyWorkObject template, String parentId) Creates a new entity based on the given template.
void	delete(String workObjectId) 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<AnyWorkObjectDefinition>	getDefinitions() Returns all definitions known to the provider.
String	getWorkObjectType() Returns the type of entity that are managed by this provider.
void	update(String workObjectId, 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, getId, removeListener

Methods inherited from class java.lang.Object

equals, 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

Method Detail

getWorkObjectType

public String getWorkObjectType()

Description copied from interface: DomainObjectProvider

Returns the type of entity that are managed by this provider.

Specified by:

getWorkObjectType in interface DomainObjectProvider

Returns:

the supported entity type

getDefinitions

public Collection<AnyWorkObjectDefinition> getDefinitions()

Description copied from interface: DomainObjectProvider

Returns all definitions known to the provider.

Specified by:

getDefinitions in interface DomainObjectProvider

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

Parameters:

resources - the definition resources to deploy

deploymentName - the name under which to deploy the given resources

create

public String create(AnyWorkObject template,
                     String parentId)

Description copied from interface: DomainObjectProvider

Creates a new entity based on the given template.

Typically, the template is 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

Parameters:

template - the definition id of the entity to create

parentId - the parent work object ID (may be null)

Returns:

the unique id of the created entity

update

public void update(String workObjectId,
                   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

Parameters:

workObjectId - the external id of the entity to update

changes - the changes to apply on the entity

delete

public void delete(String workObjectId)

Description copied from interface: DomainObjectProvider

Deletes the entity with the given id .

Specified by:

delete in interface DomainObjectProvider

Parameters:

workObjectId - the external id of the entity to delete