com.edorasware.one.rest.manager

Interface WorkObjectDefinitionManager

All Known Implementing Classes:

DefaultWorkObjectDefinitionManager

public interface WorkObjectDefinitionManager

Manages operations on AnyWorkObjectDefinitions

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

Method Detail

findWorkObjectDefinitions

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

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

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

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

QueryResponse findWorkObjectDefinitionsByModelId(String modelId,
                                                 Locale locale)

Finds the latest active work object definition by model global id

Parameters:

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

locale - the translation locale

Returns:

response with meta information

findEntityTemplateByModelId

EntityTemplate findEntityTemplateByModelId(String modelId,
                                           Locale locale)

Finds the latest active work object definition by model global id

Parameters:

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

locale - the translation locale

Returns:

response with meta information

getWorkObjectDefinition

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

Gets the definition by id

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