com.neurosys.template.model

Interface CustomTemplateRenderAdapter<T,MODEL,COMPONENT,CONTAINER_COMPONENT>

All Superinterfaces:

Serializable

All Known Implementing Classes:

CollectionTypesTemplatePanel, ContentDetailsTemplatePanel, CustomerDetailsTemplatePanel, DefaultWicketTemplateRenderAdapter, DeliveryDetailsTemplatePanel, DynamicConfigTemplatePanel, EntityDetailsTemplatePanel, ETLInputTemplatePanel, OrderDetailsTemplatePanel, ProductDetailsTemplatePanel, ProductSearchInputTemplatePanel, PromotionDetailsTemplatePanel, ReporterInputTemplatePanel, SimpleDynamicFieldsRenderAdapter, UserAttributesDetailsTemplatePanel, UserPropertiesDetailsTemplatePanel, VisitorDetailsTemplatePanel

public interface CustomTemplateRenderAdapter<T,MODEL,COMPONENT,CONTAINER_COMPONENT>
extends Serializable

Control how a particular component is rendered

Author:

Arjun Dhar

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CustomTemplateRenderAdapter.Nothing A way to indicate that the returned value has no significance and should not be used.

Field Summary

Fields

Modifier and Type	Field and Description
static CustomTemplateRenderAdapter.Nothing	nothing

Method Summary

Modifier and Type	Method and Description
COMPONENT	getComponentForType(MetaItem metaItem, String fieldComponentName, MODEL model, CONTAINER_COMPONENT container, T modelObject, User user)
String	getItemRefId(MetaItem metaItem) When rendering Items, for Feedback we may want to target messages to sections in the form.
Object	processItem(T entity, MetaItem metaItem, COMPONENT coreEntityDataField, User user, Object... contextParams) For each meta item handle processing on submit and derive the value to be submitted/persisted back
void	reset() During Ajax calls a Render Adapter maybe called multiple times.

Field Detail

nothing

static final CustomTemplateRenderAdapter.Nothing nothing

Method Detail

getComponentForType

COMPONENT getComponentForType(MetaItem metaItem,
                              String fieldComponentName,
                              MODEL model,
                              CONTAINER_COMPONENT container,
                              T modelObject,
                              User user)

Parameters:

metaItem - as MetaItem

fieldComponentName - as the rendering fieldComponentName or Id (of the component to be created)

model - as MODEL of the value extracted from the original modelObject for the MetaItem. This is a variable that would typically be extracted from the modeObject using the MetaItem, however there is complex logic that can vary and hence is expected to be provided to this method.

container - as CONTAINER_COMPONENT containing the produced component

modelObject - as the core domain Object/Entity

user - as com.neurosys.security.auth.domain.User for any Authorization related needs @nullable true

Returns:

COMPONENT

See Also:

ProductDetailsTemplatePanel#getComponentForType(MetaItem, String, MODEL, CONTAINER_COMPONENT, com.neurosys.products.domain.Product)

processItem

Object processItem(T entity,
                   MetaItem metaItem,
                   COMPONENT coreEntityDataField,
                   User user,
                   Object... contextParams)
            throws Exception

For each meta item handle processing on submit and derive the value to be submitted/persisted back

Parameters:

T - as entity

meta - as MetaItem *

Component - representing the entity form field

User -

contectParams - as Object[]; for example a resourceLocationMap as Map to specify the path where a File may be required to be stored

Returns:

Object value for the entity form field
Note: null or CustomTemplateRenderAdapter.Nothing (nothing). Nothing should not be persisted or used, it implies it should be ignored.

Throws:

Exception

getItemRefId

String getItemRefId(MetaItem metaItem)

When rendering Items, for Feedback we may want to target messages to sections in the form. A convention needs to exist to target a particular component generated from a MetaItem

Parameters:

metaItem - as MetaItem

Returns:

String

reset

void reset()

During Ajax calls a Render Adapter maybe called multiple times.
Some states may need to be reset.