Package ch.tocco.nice2.dms.spi.customdataprovider

Class EntityDocThumbnailDataProvider

java.lang.Object

ch.tocco.nice2.dms.spi.customdataprovider.EntityDocThumbnailDataProvider

All Implemented Interfaces:

CustomDataProvider

public class EntityDocThumbnailDataProvider
extends Object
implements CustomDataProvider

This data-provider returns thumbnail url (as string) of an entity doc. It can be contributed in a spring boot configuration (you need to specify entityName, fieldName and size).

 @Bean
 public CustomDataProviderContribution articleThumbnailDataProvider(TypeManager typeManager,
                                                                    Context context,
                                                                    QueryBuilderFactory queryBuilderFactory,
                                                                    ContentTreeService contentTreeService,
                                                                    SecurityManager securityManager) {
     EntityDocThumbnailDataProvider dataProvider = new EntityDocThumbnailDataProvider(typeManager, context, queryBuilderFactory, contentTreeService, securityManager);
     dataProvider.setEntityName("Article");
     dataProvider.setFieldName("pic_small");
     dataProvider.setSize(80);
     return new CustomDataProviderContribution("nice2.optional.webshop.ArticleThumbnailDataProvider", dataProvider);
 }
 

Implementation note: it resolves entity doc in privileged mode for performance reasons (you can assume that you can read an entity doc when you can read the related entity).

Constructor Summary

Constructors

Constructor	Description
EntityDocThumbnailDataProvider(TypeManager typeManager, Context context, QueryBuilderFactory queryBuilderFactory, ContentTreeService contentTreeService, SecurityManager securityManager)

Method Summary

Modifier and Type	Method	Description
CustomDataValue<?>	getData(Entity entity)	Collects the custom data for this field and returns it as a TypedValue.
void	setEntityName(String entityName)
void	setFieldName(String fieldName)
void	setSize(int size)

Methods inherited from class java.lang.Object

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

Constructor Details

EntityDocThumbnailDataProvider

public EntityDocThumbnailDataProvider(TypeManager typeManager,
 Context context,
 QueryBuilderFactory queryBuilderFactory,
 ContentTreeService contentTreeService,
 SecurityManager securityManager)

Method Details

getData

public CustomDataValue<?> getData(Entity entity)
                           throws CustomDataProviderException

Description copied from interface: CustomDataProvider

Collects the custom data for this field and returns it as a TypedValue.

Specified by:

getData in interface CustomDataProvider

Parameters:

entity - The current entity, which gets loaded in the grid or form (is null in create scope).

Returns:

a TypedValue containing the custom data for this field.

Throws:

CustomDataProviderException - in case of error.

setEntityName

public void setEntityName(String entityName)

setFieldName

public void setFieldName(String fieldName)

setSize

public void setSize(int size)