com.edorasware.one.rest.manager.internal

Class DefaultWorkObjectDefinitionManager

java.lang.Object

com.edorasware.one.rest.manager.internal.DefaultWorkObjectDefinitionManager

All Implemented Interfaces:

WorkObjectDefinitionManager

@Manager
public class DefaultWorkObjectDefinitionManager
extends Object
implements WorkObjectDefinitionManager

Manages operations on AnyWorkObjectDefinitions

Constructor Summary

Constructors

Constructor and Description
DefaultWorkObjectDefinitionManager(EntityTemplateManager entityTemplateManager, AnyWorkObjectDefinitionService workObjectDefinitionService)

Method Summary

Modifier and Type	Method and Description
EntityTemplate	findEntityTemplateByModelId(String modelId, Locale locale) Finds the latest active work object definition by model global id
QueryResponse	findWorkObjectDefinitions(String type, String typedText, Integer offset, Integer limit, Locale locale) Finds the work object definitions with a matching name to the typed text parameter
QueryResponse	findWorkObjectDefinitionsByModelId(String modelId, Locale locale) Finds the latest active work object definition by model global id
QueryResponse	findWorkObjectDefinitionsWithCaseId(String type, String caseId, String typedText, Integer offset, Integer limit, Locale locale) Finds the latest work object definitions with a matching name to the typed text parameter and the case id
ValueMap	getWorkObjectDefinition(String ambiguousWorkObjectDefinitionId, DefinitionViewFilter definitionViewFilter, Collection<String> fields, Locale locale, String... allowedTypes) Gets the definition by id

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultWorkObjectDefinitionManager

public DefaultWorkObjectDefinitionManager(EntityTemplateManager entityTemplateManager,
                                          AnyWorkObjectDefinitionService workObjectDefinitionService)

Method Detail

findWorkObjectDefinitions

public QueryResponse findWorkObjectDefinitions(String type,
                                               String typedText,
                                               Integer offset,
                                               Integer limit,
                                               Locale locale)

Description copied from interface: WorkObjectDefinitionManager

Finds the work object definitions with a matching name to the typed text parameter

Specified by:

findWorkObjectDefinitions in interface WorkObjectDefinitionManager

Parameters:

type - work object definition type to search for

typedText - search in the definitions according to the names

offset - the start of the rows to fetch

limit - the size of fetched data

locale - the translation locale

Returns:

response with meta information

findWorkObjectDefinitionsWithCaseId

public QueryResponse findWorkObjectDefinitionsWithCaseId(String type,
                                                         String caseId,
                                                         String typedText,
                                                         Integer offset,
                                                         Integer limit,
                                                         Locale locale)

Description copied from interface: WorkObjectDefinitionManager

Finds the latest work object definitions with a matching name to the typed text parameter and the case id

Specified by:

findWorkObjectDefinitionsWithCaseId in interface WorkObjectDefinitionManager

Parameters:

type - work object definition type to search for

caseId - case id or case global id to restrict the definitions search

typedText - search in the definitions according to the names

offset - the start of the rows to fetch

limit - the size of fetched data

locale - the translation locale

Returns:

response with meta information

findWorkObjectDefinitionsByModelId

public QueryResponse findWorkObjectDefinitionsByModelId(String modelId,
                                                        Locale locale)

Description copied from interface: WorkObjectDefinitionManager

Finds the latest active work object definition by model global id

Specified by:

findWorkObjectDefinitionsByModelId in interface WorkObjectDefinitionManager

Parameters:

modelId - global id of the model to find the latest work object definition

locale - the translation locale

Returns:

response with meta information

getWorkObjectDefinition

public ValueMap getWorkObjectDefinition(String ambiguousWorkObjectDefinitionId,
                                        DefinitionViewFilter definitionViewFilter,
                                        Collection<String> fields,
                                        Locale locale,
                                        String... allowedTypes)

Description copied from interface: WorkObjectDefinitionManager

Gets the definition by id

Specified by:

getWorkObjectDefinition in interface WorkObjectDefinitionManager

Parameters:

ambiguousWorkObjectDefinitionId - definition Id or global modal Id

definitionViewFilter - definition view filter to limit returned attributes

fields - attributes included into response

locale - the translation locale

allowedTypes - types expected in the response. If empty all types are allowed.

Returns:

definition attributes

findEntityTemplateByModelId

public EntityTemplate findEntityTemplateByModelId(String modelId,
                                                  Locale locale)

Description copied from interface: WorkObjectDefinitionManager

Finds the latest active work object definition by model global id

Specified by:

findEntityTemplateByModelId in interface WorkObjectDefinitionManager

Parameters:

modelId - global id of the model to find the latest work object definition

locale - the translation locale

Returns:

response with meta information