com.edorasware.commons.core.provider.entity

Interface DomainObjectProvider

All Superinterfaces:

EntityProvider<AnyWorkObjectProviderListener>, Identifiable

All Known Subinterfaces:

AnyWorkObjectProvider, ProcessProvider, TaskProvider, WorkObjectProvider

All Known Implementing Classes:

AbstractAdminDashboardProvider, AbstractModelerDashboardProvider, AbstractUserDashboardProvider, ActivitiProcessProvider, ActivitiTaskProvider, AdhocTaskProvider, AppModelProvider, BaseAnyWorkObjectProvider, BaseDomainObjectProvider, BaseProcessProvider, BaseTaskProvider, BaseWorkObjectProvider, CaseModelProvider, CloudAccountProvider, CloudCaseProvider, CloudDocumentProvider, CmmnCaseProvider, CmmnCaseProviderProxy, CmmnTaskProvider, DmnModelProvider, DocumentModelProvider, FlowableDmnProvider, FormModelProvider, MailModelProvider, ProcessModelProvider, QueryProvider, TaskModelProvider, TenantProvider

public interface DomainObjectProvider
extends EntityProvider<AnyWorkObjectProviderListener>

Represents the base entity provider interface.

Method Summary

Modifier and Type	Method and Description
String	create(AnyWorkObject template, String parentWorkObjectId) 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 interface com.edorasware.commons.core.provider.entity.EntityProvider

addListener, removeListener

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

getId

Method Detail

getWorkObjectType

String getWorkObjectType()

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

Returns:

the supported entity type

getDefinitions

Collection<AnyWorkObjectDefinition> 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

String create(AnyWorkObject template,
              String parentWorkObjectId)

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.

Parameters:

template - the definition id of the entity to create

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

Returns:

the unique id of the created entity

Throws:

RuntimeException - if the entity cannot be created

update

void update(String workObjectId,
            List<FieldChange> changes)

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

Parameters:

workObjectId - the external 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(String workObjectId)

Deletes the entity with the given id .

Parameters:

workObjectId - the external 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