com.edorasware.commons.core.any

Interface AnyWorkObjectDefinitionService

All Superinterfaces:

EntityService<AnyWorkObjectDefinition>

All Known Implementing Classes:

DefaultAnyWorkObjectDefinitionService

public interface AnyWorkObjectDefinitionService
extends EntityService<AnyWorkObjectDefinition>

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

Method Summary

Modifier and Type	Method and Description
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.
long	countWorkObjectDefinitions(Query query) Counts the concrete work object definitions that match the given query.
long	countWorkObjectDefinitions(Query query, SearchScope searchScope) Counts the concrete work object definitions that match the given query in given scope.
void	deployWorkObjectDefinitions(List<org.springframework.core.io.Resource> resources, String workObjectProviderId) Deploys the given resources describing concrete work object definitions as one deployment unit.
String	findParentId(AnyWorkObjectDefinition definition) Returns the parent work object.
String	findParentIdByType(AnyWorkObjectDefinition definition, String requiredType) Returns the closest parent work object of the given type for a given work object.
String	findTopMostParentIdByType(AnyWorkObjectDefinition definition, String requiredType, boolean includeSelf) Returns the top-most parent work object of the given type for a given work object.
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	findWorkObjectDefinition(Query query) Finds the concrete work object definition that matches the given query.
AnyWorkObjectDefinition	findWorkObjectDefinition(Query query, SearchScope searchScope) Finds the concrete work object definition that matches the given query in given scope.
AnyWorkObjectDefinition	findWorkObjectDefinitionByExternalId(String externalId) Finds the concrete work object definition with the given external id.
AnyWorkObjectDefinition	findWorkObjectDefinitionByExternalId(String externalId, SearchScope searchScope) Finds the concrete work object definition with the given external id in the given scope.
AnyWorkObjectDefinition	findWorkObjectDefinitionById(String id) Finds the concrete work object definition with the given definition id.
AnyWorkObjectDefinition	findWorkObjectDefinitionById(String id, SearchScope searchScope) Finds the concrete work object definition with the given concrete work object definition id in the 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.
List<AnyWorkObjectDefinition>	findWorkObjectDefinitions(Query query) Finds the concrete work object definitions that match the given query.
List<AnyWorkObjectDefinition>	findWorkObjectDefinitions(Query query, SearchScope searchScope) Finds the concrete work object definitions that match the given query in given scope.
String	getRootId(AnyWorkObjectDefinition definition) Returns the root work object ID for a given work object.
AnyWorkObjectDefinition	getWorkObjectDefinitionById(String id) Finds the work object definition with the given work object definition id.
AnyWorkObjectDefinition	getWorkObjectDefinitionById(String 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.EntityService

countEntities, countEntities, countEntities, countEntities, create, create, findEntities, findEntities, findEntities, findEntities, findEntity, findEntity, findEntity, findEntity, findEntityByExternalId, findEntityByExternalId, findEntityByGlobalId, findEntityByGlobalId, findEntityById, findEntityById, findIdByExternalId, findIdByExternalId, getEntityByGlobalId, getEntityByGlobalId, getEntityById, getEntityById

Method Detail

getWorkObjectDefinitionById

AnyWorkObjectDefinition getWorkObjectDefinitionById(String 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(String 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(String 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(String 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(String 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(String 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. <p> 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. <p> 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. <p> 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. <p> 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(Query 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(Query 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(Query 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(Query 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(Query 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(Query 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

deployWorkObjectDefinitions

void deployWorkObjectDefinitions(List<org.springframework.core.io.Resource> resources,
                                 String 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

findParentId

String findParentId(AnyWorkObjectDefinition definition)

Returns the parent work object.

Returns:

the parent work object definition ID or null if the work object has no parent

findParentIdByType

String findParentIdByType(AnyWorkObjectDefinition definition,
                          String requiredType)

Returns the closest parent work object of the given type for a given work object.

Parameters:

definition - the work object definition

requiredType - the required work object type

Returns:

the parent work object definition ID or null if there was no match

findTopMostParentIdByType

String findTopMostParentIdByType(AnyWorkObjectDefinition definition,
                                 String requiredType,
                                 boolean includeSelf)

Returns the top-most parent work object of the given type for a given work object.

Parameters:

definition - the work object definition

requiredType - the required work object type

includeSelf - true if the starting work object should be included in the search

Returns:

the parent work object definition ID or null if there was no match

getRootId

String getRootId(AnyWorkObjectDefinition definition)

Returns the root work object ID for a given work object.

Parameters:

definition - the work object definition

Returns:

the root work object definition ID (may be the ID work object itself if there is no parent).