com.edorasware.commons.core.any

Interface AnyWorkObjectDefinitionService

All Superinterfaces:

DomainObjectDefinitionService<WorkObjectDefinitionId,AnyWorkObjectProviderId,AnyWorkObjectDefinition,AnyWorkObjectDefinitionQuery>, EntityService<WorkObjectDefinitionId,AnyWorkObjectProviderId,AnyWorkObjectDefinition,AnyWorkObjectDefinitionQuery>, Service, WorkObjectDefinitionService<WorkObjectDefinitionId,AnyWorkObjectProviderId,AnyWorkObjectDefinition,AnyWorkObjectDefinitionQuery>

public interface AnyWorkObjectDefinitionService
extends WorkObjectDefinitionService<WorkObjectDefinitionId,AnyWorkObjectProviderId,AnyWorkObjectDefinition,AnyWorkObjectDefinitionQuery>

The service to access the concrete work object definition management functionality.

Method Summary

Modifier and Type	Method and Description
WorkObjectDefinitionId	addWorkObjectDefinition(AnyWorkObjectDefinition definition, String description) Adds the given ad-hoc concrete work object definition with no parent applied.
WorkObjectDefinitionId	addWorkObjectDefinition(AnyWorkObjectDefinition definition, WorkObjectDefinitionId parentId, String description) Adds the given ad-hoc concrete work object definition under the given parent.
long	countWorkObjectDefinitions(AnyWorkObjectDefinitionQuery query) Counts the concrete work object definitions that match the given query.
long	countWorkObjectDefinitions(AnyWorkObjectDefinitionQuery query, SearchScope searchScope) Counts the concrete work object definitions that match the given query in given scope.
long	countWorkObjectDefinitions(Predicate anyWorkObjectDefinitionPredicate) Counts the concrete work objects that match the query with the given predicate.
long	countWorkObjectDefinitions(Predicate anyWorkObjectDefinitionPredicate, SearchScope searchScope) Counts the concrete work objects that match the query with the given predicate in given scope.
void	deployWorkObjectDefinitions(List<org.springframework.core.io.Resource> resources, AnyWorkObjectProviderId workObjectProviderId) Deploys the given resources describing concrete work object definitions as one deployment unit.
AnyWorkObjectDefinition	findWorkObjectDefinition(AnyWorkObjectDefinitionQuery query) Finds the concrete work object definition that matches the given query.
AnyWorkObjectDefinition	findWorkObjectDefinition(AnyWorkObjectDefinitionQuery query, SearchScope searchScope) Finds the concrete work object definition that matches the given query in given scope.
AnyWorkObjectDefinition	findWorkObjectDefinition(Predicate anyWorkObjectDefinitionPredicate) Finds the concrete work object definition that matches the query with the given predicate.
AnyWorkObjectDefinition	findWorkObjectDefinition(Predicate anyWorkObjectDefinitionPredicate, SearchScope searchScope) Finds the concrete work object definition that matches the query with the given predicate in given scope.
AnyWorkObjectDefinition	findWorkObjectDefinitionByExternalId(WorkObjectDefinitionId externalId) Finds the concrete work object definition with the given external id.
AnyWorkObjectDefinition	findWorkObjectDefinitionByExternalId(WorkObjectDefinitionId externalId, SearchScope searchScope) Finds the concrete work object definition with the given external id in the given scope.
AnyWorkObjectDefinition	findWorkObjectDefinitionById(WorkObjectDefinitionId id) Finds the concrete work object definition with the given definition id.
AnyWorkObjectDefinition	findWorkObjectDefinitionById(WorkObjectDefinitionId id, SearchScope searchScope) Finds the concrete work object definition with the given concrete work object definition id in the given scope.
List<AnyWorkObjectDefinition>	findWorkObjectDefinitions(AnyWorkObjectDefinitionQuery query) Finds the concrete work object definitions that match the given query.
List<AnyWorkObjectDefinition>	findWorkObjectDefinitions(AnyWorkObjectDefinitionQuery query, SearchScope searchScope) Finds the concrete work object definitions that match the given query in given scope.
List<AnyWorkObjectDefinition>	findWorkObjectDefinitions(Predicate anyWorkObjectDefinitionPredicate) Finds the concrete work object definitions that match the query with the given predicate.
List<AnyWorkObjectDefinition>	findWorkObjectDefinitions(Predicate anyWorkObjectDefinitionPredicate, SearchScope searchScope) Finds the concrete work object definitions that match the query with the given predicate in given scope.
AnyWorkObjectDefinition	getWorkObjectDefinitionById(WorkObjectDefinitionId id) Finds the work object definition with the given work object definition id.
AnyWorkObjectDefinition	getWorkObjectDefinitionById(WorkObjectDefinitionId id, SearchScope searchScope) Finds the work object definition with the given work object definition id in the given scope.

Methods inherited from interface com.edorasware.commons.core.service.entity.WorkObjectDefinitionService

addEntity

Methods inherited from interface com.edorasware.commons.core.service.entity.DomainObjectDefinitionService

deployEntities

Methods inherited from interface com.edorasware.commons.core.service.entity.EntityService

addEntity, addEntityGeneric, countEntities, countEntities, countEntities, countEntities, findEntities, findEntities, findEntities, findEntities, findEntity, findEntity, findEntity, findEntity, findEntityByExternalId, findEntityByExternalId, findEntityByGlobalId, findEntityByGlobalId, findEntityById, findEntityById, findExternalIdByGlobalId, findExternalIdByGlobalId, findExternalIdById, findExternalIdById, findGlobalIdByExternalId, findGlobalIdByExternalId, findIdByExternalId, findIdByExternalId, getEntityByGlobalId, getEntityByGlobalId, getEntityById, getEntityById

Methods inherited from interface com.edorasware.commons.core.util.service.Service

init

Method Detail

getWorkObjectDefinitionById

AnyWorkObjectDefinition getWorkObjectDefinitionById(WorkObjectDefinitionId id)

Finds the work object definition with the given work object definition id. If no work object definition matches the given id, an exception is thrown.

Parameters:

id - the id of the work object definition to find

Returns:

the matching work object definition

Throws:

EntityNotFoundException - if work object definition cannot be found

getWorkObjectDefinitionById

AnyWorkObjectDefinition getWorkObjectDefinitionById(WorkObjectDefinitionId id,
                                                    SearchScope searchScope)

Finds the work object definition with the given work object definition id in the given scope. If no work object definition matches the given id, an exception is thrown.

Parameters:

id - the id of the work object definition to find

searchScope - the scope in which to search for the work object definition

Returns:

the matching work object definition

Throws:

EntityNotFoundException - if work object definition cannot be found

findWorkObjectDefinitionById

AnyWorkObjectDefinition findWorkObjectDefinitionById(WorkObjectDefinitionId id)

Finds the concrete work object definition with the given definition id. If no concrete work object definition matches the given id, null is returned.

Parameters:

id - the id of the concrete work object definition to find

Returns:

the matching concrete work object definition

findWorkObjectDefinitionById

AnyWorkObjectDefinition findWorkObjectDefinitionById(WorkObjectDefinitionId id,
                                                     SearchScope searchScope)

Finds the concrete work object definition with the given concrete work object definition id in the given scope. If no concrete work object definition matches the given id, null is returned.

Parameters:

id - the id of the concrete work object definition to find

searchScope - the scope in which to search for the concrete work object definition

Returns:

the matching concrete work object definition

findWorkObjectDefinitionByExternalId

AnyWorkObjectDefinition findWorkObjectDefinitionByExternalId(WorkObjectDefinitionId externalId)

Finds the concrete work object definition with the given external id. If no concrete work object definition matches the given external id, null is returned.

Parameters:

externalId - the external id of the concrete work object definition to find

Returns:

the matching concrete work object definition

findWorkObjectDefinitionByExternalId

AnyWorkObjectDefinition findWorkObjectDefinitionByExternalId(WorkObjectDefinitionId externalId,
                                                             SearchScope searchScope)

Finds the concrete work object definition with the given external id in the given scope. If no concrete work object definition matches the given external id, null is returned.

Parameters:

externalId - the external id of the concrete work object definition to find

searchScope - the scope in which to search for the concrete work object definition

Returns:

the matching concrete work object definition

findWorkObjectDefinition

AnyWorkObjectDefinition findWorkObjectDefinition(Predicate anyWorkObjectDefinitionPredicate)

Finds the concrete work object definition that matches the query with the given predicate. If no concrete work object definition matches the query with the given predicate, null is returned. If more than one concrete work object definition matches the query with the predicate, an exception is thrown.

Note: No sorting, paging, nor query hints are applied. This can become a potential query performance issue.

Parameters:

anyWorkObjectDefinitionPredicate - the predicate to apply when executing the query

Returns:

the matching concrete work object definition

findWorkObjectDefinition

AnyWorkObjectDefinition findWorkObjectDefinition(Predicate anyWorkObjectDefinitionPredicate,
                                                 SearchScope searchScope)

Finds the concrete work object definition that matches the query with the given predicate in given scope. If no concrete work object definition matches the query with the given predicate in given scope, null is returned. If more than one concrete work object definition matches the query with the predicate in given scope, an exception is thrown.

Note: No sorting, paging, nor query hints are applied. This can become a potential query performance issue.

Parameters:

anyWorkObjectDefinitionPredicate - the predicate to apply when executing the query

searchScope - the scope in which to search for the concrete work object definition

Returns:

the matching concrete work object definition

findWorkObjectDefinitions

List<AnyWorkObjectDefinition> findWorkObjectDefinitions(Predicate anyWorkObjectDefinitionPredicate)

Finds the concrete work object definitions that match the query with the given predicate. If no concrete work object definition matches the query with the given predicate, an empty list is returned.

Note: No sorting, paging, nor query hints are applied. This can become a potential query performance issue.

Parameters:

anyWorkObjectDefinitionPredicate - the predicate to apply when executing the query

Returns:

the matching concrete work object definitions

findWorkObjectDefinitions

List<AnyWorkObjectDefinition> findWorkObjectDefinitions(Predicate anyWorkObjectDefinitionPredicate,
                                                        SearchScope searchScope)

Finds the concrete work object definitions that match the query with the given predicate in given scope. If no concrete work object definition matches the query with the given predicate in given scope, an empty list is returned.

Note: No sorting, paging, nor query hints are applied. This can become a potential query performance issue.

Parameters:

anyWorkObjectDefinitionPredicate - the predicate to apply when executing the query

searchScope - the scope in which to search for the concrete work object definitions

Returns:

the matching concrete work object definitions

countWorkObjectDefinitions

long countWorkObjectDefinitions(Predicate anyWorkObjectDefinitionPredicate)

Counts the concrete work objects that match the query with the given predicate.

Parameters:

anyWorkObjectDefinitionPredicate - the predicate to apply when executing the query

Returns:

the number of matching concrete work object definitions

countWorkObjectDefinitions

long countWorkObjectDefinitions(Predicate anyWorkObjectDefinitionPredicate,
                                SearchScope searchScope)

Counts the concrete work objects that match the query with the given predicate in given scope.

Parameters:

anyWorkObjectDefinitionPredicate - the predicate to apply when executing the query

searchScope - the scope in which to count number of concrete work object definitions

Returns:

the number of matching concrete work object definitions

findWorkObjectDefinition

AnyWorkObjectDefinition findWorkObjectDefinition(AnyWorkObjectDefinitionQuery query)

Finds the concrete work object definition that matches the given query. If no concrete work object definition matches the given query, null is returned. If more than one concrete work object definition matches the query, an exception is thrown.

Parameters:

query - the query to execute

Returns:

the matching concrete work object definition

findWorkObjectDefinition

AnyWorkObjectDefinition findWorkObjectDefinition(AnyWorkObjectDefinitionQuery query,
                                                 SearchScope searchScope)

Finds the concrete work object definition that matches the given query in given scope. If no concrete work object definition matches the given query in given scope, null is returned. If more than one concrete work object definition matches the query, an exception is thrown.

Parameters:

query - the query to execute

searchScope - the scope in which to search for the concrete work object definition

Returns:

the matching concrete work object definition

findWorkObjectDefinitions

List<AnyWorkObjectDefinition> findWorkObjectDefinitions(AnyWorkObjectDefinitionQuery query)

Finds the concrete work object definitions that match the given query. If no concrete work object definition matches the given query, an empty list is returned.

Parameters:

query - the query to execute

Returns:

the matching concrete work object definitions

findWorkObjectDefinitions

List<AnyWorkObjectDefinition> findWorkObjectDefinitions(AnyWorkObjectDefinitionQuery query,
                                                        SearchScope searchScope)

Finds the concrete work object definitions that match the given query in given scope. If no concrete work object definition matches the given query in given scope, an empty list is returned.

Parameters:

query - the query to execute

searchScope - the scope in which to search for the concrete work object definitions

Returns:

the matching concrete work object definitions

countWorkObjectDefinitions

long countWorkObjectDefinitions(AnyWorkObjectDefinitionQuery query)

Counts the concrete work object definitions that match the given query.

Parameters:

query - the query to execute

Returns:

the number of matching concrete work object definitions

countWorkObjectDefinitions

long countWorkObjectDefinitions(AnyWorkObjectDefinitionQuery query,
                                SearchScope searchScope)

Counts the concrete work object definitions that match the given query in given scope.

Parameters:

query - the query to execute

searchScope - the scope in which to count number of concrete work object definitions

Returns:

the number of matching concrete work object definitions

addWorkObjectDefinition

WorkObjectDefinitionId addWorkObjectDefinition(AnyWorkObjectDefinition definition,
                                               String description)

Adds the given ad-hoc concrete work object definition with no parent applied. If the concrete work object definition's id is undefined, the concrete work object definition id is generated by the persistence component of the system and guaranteed to be unique. In all other cases, the contributor of the concrete work object definition needs to ensure that the concrete work object definition's id is unique.

Parameters:

definition - the ad-hoc concrete work object definition to add

description - transient meta information regarding the reason to add the ad-hoc concrete work object definition

Returns:

the persisted concrete work object definition id

See Also:

Entity.getId(), Entity.getExternalId()

addWorkObjectDefinition

WorkObjectDefinitionId addWorkObjectDefinition(AnyWorkObjectDefinition definition,
                                               WorkObjectDefinitionId parentId,
                                               String description)

Adds the given ad-hoc concrete work object definition under the given parent. If the concrete work object definition's id is undefined, the concrete work object definition id is generated by the persistence component of the system and guaranteed to be unique. In all other cases, the contributor of the concrete work object definition needs to ensure that the concrete work object definition's id is unique.

Parameters:

definition - the ad-hoc concrete work object definition to add

parentId - the parent definition under which to add the ad-hoc concrete work object definition

description - transient meta information regarding the reason to add the ad-hoc concrete work object definition

Returns:

the persisted concrete work object definition id

See Also:

Entity.getId(), Entity.getExternalId()

deployWorkObjectDefinitions

void deployWorkObjectDefinitions(List<org.springframework.core.io.Resource> resources,
                                 AnyWorkObjectProviderId workObjectProviderId)

Deploys the given resources describing concrete work object definitions as one deployment unit.

Parameters:

resources - the resources to deploy, typically concrete work object definitions

workObjectProviderId - the provider responsible to execute the deployment