com.edorasware.one.entitytemplate

Interface EntityTemplateManager

All Known Implementing Classes:

DefaultEntityTemplateManager

public interface EntityTemplateManager

This class specifies interface for providing object definitions to the frontend.

Method Summary

Modifier and Type	Method and Description
EntityTemplate	getEntityTemplateById(String definitionId, Locale locale) Get work object definition for a given definition id.
EntityTemplate	getEntityTemplateByModelId(String modelId, Locale locale) Returns the latest version of EntityTemplate with the given model id.
List<EntityTemplate>	getEntityTemplatesByType(String type, String nameContains, Locale locale) Returns all localized definitions for a given definition Type.
List<EntityTemplate>	getEntityTemplatesByTypeAndCase(String type, String ambiguousId, String nameContains, Locale locale) Returns all localized definitions for a given definition Type and a given case ID.

Method Detail

getEntityTemplateById

EntityTemplate getEntityTemplateById(String definitionId,
                                     Locale locale)

Get work object definition for a given definition id.

Parameters:

definitionId - definitionId to provide

locale - the locale to be used for translation

Returns:

localized frontend object definition

getEntityTemplateByModelId

EntityTemplate getEntityTemplateByModelId(String modelId,
                                          Locale locale)

Returns the latest version of EntityTemplate with the given model id.

Parameters:

modelId - the model id of the entity template

locale - the locale to be used for translation

Returns:

the localized entity template

getEntityTemplatesByType

List<EntityTemplate> getEntityTemplatesByType(String type,
                                              String nameContains,
                                              Locale locale)

Returns all localized definitions for a given definition Type.

Parameters:

type - the type of the definition

nameContains - the text used for the name like search

locale - the locale to be used for translation

Returns:

a list of localized entity template definitions

getEntityTemplatesByTypeAndCase

List<EntityTemplate> getEntityTemplatesByTypeAndCase(String type,
                                                     String ambiguousId,
                                                     String nameContains,
                                                     Locale locale)

Returns all localized definitions for a given definition Type and a given case ID.

Parameters:

type - the type of the definition

ambiguousId - the case id (may be work object ID value or global ID value)

nameContains - the text used for the name like search

locale - the locale to be used for translation

Returns:

a list of localized entity template definitions