Package ch.tocco.nice2.netui.impl.bind.entity

Class EntityServiceImpl

java.lang.Object

ch.tocco.nice2.netui.impl.bind.form.AbstractFormRebindService

ch.tocco.nice2.netui.impl.bind.entity.EntityServiceImpl

All Implemented Interfaces:

EntityService

public class EntityServiceImpl
extends AbstractFormRebindService
implements EntityService

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	EntityServiceImpl.RawResolver

Nested classes/interfaces inherited from interface ch.tocco.nice2.netui.impl.bind.entity.EntityService

EntityService.EntityFormDataException, EntityService.EntityPutResultException

Field Summary

Fields inherited from class ch.tocco.nice2.netui.impl.bind.form.AbstractFormRebindService

dataModel, internalFormService, typeManager

Constructor Summary

Constructors

Constructor

Description

EntityServiceImpl(org.slf4j.Logger log, TypeManager typeManager, UriResolver uriResolver, Context context, SecurityManager securityManager, DefaultValueResolver defaultValueResolver, DataModel dataModel, RebindService rebindService, InternalFormService internalFormService, ConstrictionManager constrictionManager, QueryPopulator queryPopulator, DisplayFactory displayFactory, QueryBuilderFactory queryBuilderFactory, BusinessUnitManager businessUnitManager, DefaultDisplayService defaultDisplayService, CommandExecutor executor)

Method Summary

Modifier and Type	Method	Description
EntityPutResult	_put(RebindService.Scope scope, RebindValue[] values)
EntityFormData	getDataForForm(String formUri, String entityUri)	Returns the data for a form when bound to the entity specified.
AbstractFieldInfo[]	getDefaultValuesForForm(String formUriString)
AbstractFieldInfo[]	getDefaultValuesForFormWithOverrides(String formUriString, @Nullable DefaultValueOverride[] overrides)	Returns the default values for a form.
AbstractFieldInfo[]	getDefaultValuesForFormWithOverrides(String formUriString, @Nullable DefaultValueOverride[] overrides, @Nullable Boolean checkCreatePermission)	Returns the default values for a form.
AbstractFieldInfo[]	getEmptyFormBindings(String formUriString)
String	getEntityDisplay(URI uri)	Returns the default display for an entity.
List<SelectionFieldInfo.SelectionValue>	getOptions(String fieldName, String formName)	Asynchronously load options for a combo-box.
List<SelectionFieldInfo.SelectionValue>	getOptions(String fieldName, String formName, @Nullable String[] businessUnits)	This method may be simplified in the future: see task #52224
Map<String,String>	getPkForCountry(String iso3166)	TODO This probably doesn't belong here.
ArrayList<HashMap<String,String>>	getValuesForLookupDropdown(String entityName)
EntityPutResult	put(RebindValue[] values)
EntityPutResult	putWithScope(String scopeString, RebindValue[] values)	Stores the values.
void	setCustomDataProviders(List<CustomDataProviderContribution> customDataProviders)

Methods inherited from class ch.tocco.nice2.netui.impl.bind.form.AbstractFormRebindService

collectDataComponents, collectDataComponents, collectIteratorDataComponents, expectDataComponent, expectDataComponent, getDataTypeFromComponent

Methods inherited from class java.lang.Object

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

Constructor Details

EntityServiceImpl

public EntityServiceImpl(org.slf4j.Logger log,
 TypeManager typeManager,
 UriResolver uriResolver,
 Context context,
 SecurityManager securityManager,
 DefaultValueResolver defaultValueResolver,
 DataModel dataModel,
 RebindService rebindService,
 InternalFormService internalFormService,
 ConstrictionManager constrictionManager,
 QueryPopulator queryPopulator,
 DisplayFactory displayFactory,
 QueryBuilderFactory queryBuilderFactory,
 BusinessUnitManager businessUnitManager,
 DefaultDisplayService defaultDisplayService,
 CommandExecutor executor)

Method Details

setCustomDataProviders

@Autowired(required=false)
public void setCustomDataProviders(List<CustomDataProviderContribution> customDataProviders)

getDefaultValuesForForm

public AbstractFieldInfo[] getDefaultValuesForForm(String formUriString)
                                            throws UnresolvableUriException,
UriStoreException,
URISyntaxException,
InterruptedException,
CustomDataProviderException

Specified by:

getDefaultValuesForForm in interface EntityService

Throws:

UnresolvableUriException

UriStoreException

URISyntaxException

InterruptedException

CustomDataProviderException

See Also:

• EntityService.getDefaultValuesForFormWithOverrides(java.lang.String, ch.tocco.nice2.netui.impl.bind.entity.DefaultValueOverride[])

getDefaultValuesForFormWithOverrides

public AbstractFieldInfo[] getDefaultValuesForFormWithOverrides(String formUriString,
 @Nullable
 @Nullable DefaultValueOverride[] overrides)
                                                         throws UnresolvableUriException,
UriStoreException,
URISyntaxException,
InterruptedException,
CustomDataProviderException

Description copied from interface: EntityService

Returns the default values for a form.

Specified by:

getDefaultValuesForFormWithOverrides in interface EntityService

Parameters:

formUriString - eg "form://My_entity/create". The supported scopes for default values are 'create' and 'search'. The 'create' scope also consults the entity model whereas the 'search' scope only looks in the form models.

overrides - Allows to add/override default values from the js calling code. See js for how it's used.

Returns:

Returns an entry for every field in the form, even if it does not have a real default value (null-object). This is required for the databinding.

Throws:

UnresolvableUriException

UriStoreException

URISyntaxException

InterruptedException

CustomDataProviderException

getDefaultValuesForFormWithOverrides

public AbstractFieldInfo[] getDefaultValuesForFormWithOverrides(String formUriString,
 @Nullable
 @Nullable DefaultValueOverride[] overrides,
 @Nullable
 @Nullable Boolean checkCreatePermission)
                                                         throws UnresolvableUriException,
UriStoreException,
URISyntaxException,
InterruptedException,
CustomDataProviderException

Description copied from interface: EntityService

Returns the default values for a form.

Specified by:

getDefaultValuesForFormWithOverrides in interface EntityService

Parameters:

formUriString - eg "form://My_entity/create". The supported scopes for default values are 'create' and 'search'. The 'create' scope also consults the entity model whereas the 'search' scope only looks in the form models.

overrides - Allows to add/override default values from the js calling code. See js for how it's used.

checkCreatePermission - A boolean to specify whether fields which mustn't be edited by the user should be hidden or not (true to hide the fields; defaults to true if scope is CREATE, else false)

Returns:

Returns an entry for every field in the form, even if it does not have a real default value (null-object). This is required for the databinding.

Throws:

UnresolvableUriException

UriStoreException

URISyntaxException

InterruptedException

CustomDataProviderException

getEmptyFormBindings

public AbstractFieldInfo[] getEmptyFormBindings(String formUriString)
                                         throws URISyntaxException,
UnresolvableUriException,
UriStoreException

Specified by:

getEmptyFormBindings in interface EntityService

Throws:

URISyntaxException

UnresolvableUriException

UriStoreException

getOptions

public List<SelectionFieldInfo.SelectionValue> getOptions(String fieldName,
 String formName)
                                                   throws URISyntaxException,
UriStoreException,
UnresolvableUriException

Description copied from interface: EntityService

Asynchronously load options for a combo-box.

Specified by:

getOptions in interface EntityService

Parameters:

fieldName - name of the field

formName - name of the form

Returns:

a list of SelectionValues

Throws:

URISyntaxException - -

UriStoreException - -

UnresolvableUriException - -

getOptions

public List<SelectionFieldInfo.SelectionValue> getOptions(String fieldName,
 String formName,
 @Nullable
 @Nullable String[] businessUnits)
                                                   throws URISyntaxException,
UriStoreException,
UnresolvableUriException

This method may be simplified in the future: see task #52224

Specified by:

getOptions in interface EntityService

Throws:

URISyntaxException

UriStoreException

UnresolvableUriException

getDataForForm

public EntityFormData getDataForForm(String formUri,
 String entityUri)
                              throws UnresolvableUriException,
UriStoreException,
URISyntaxException,
CustomDataProviderException,
NoEntityToLoadException

Description copied from interface: EntityService

Returns the data for a form when bound to the entity specified.

Specified by:

getDataForForm in interface EntityService

Parameters:

entityUri - eg "entity://User/1"

Returns:

Returns an entry for every field in the form, even if it does not have a value (null-object). This is required for the databinding.

Throws:

UnresolvableUriException

UriStoreException

URISyntaxException

CustomDataProviderException

NoEntityToLoadException

getEntityDisplay

public String getEntityDisplay(URI uri)
                        throws UnresolvableUriException,
UriStoreException

Description copied from interface: EntityService

Returns the default display for an entity.

Specified by:

getEntityDisplay in interface EntityService

Parameters:

uri - eg "entity://User/1#display" TODO is this really the case that '#display' must be passed in the param?

Returns:

The default display for the requested entity instance.

Throws:

UnresolvableUriException

UriStoreException

put

public EntityPutResult put(RebindValue[] values)
                    throws UnresolvableUriException,
UriStoreException,
RebindException,
URISyntaxException,
InterruptedException,
CommitException,
EntityService.EntityPutResultException

Specified by:

put in interface EntityService

Throws:

UnresolvableUriException

UriStoreException

RebindException

URISyntaxException

InterruptedException

CommitException

EntityService.EntityPutResultException

putWithScope

public EntityPutResult putWithScope(String scopeString,
 RebindValue[] values)
                             throws UnresolvableUriException,
UriStoreException,
RebindException,
URISyntaxException,
InterruptedException,
CommitException,
EntityService.EntityPutResultException

Description copied from interface: EntityService

Stores the values.

Specified by:

putWithScope in interface EntityService

Parameters:

scopeString - One of "create", "update", "copy".

Throws:

UnresolvableUriException

UriStoreException

RebindException

URISyntaxException

InterruptedException

CommitException

EntityService.EntityPutResultException

getPkForCountry

public Map<String,String> getPkForCountry(String iso3166)

Description copied from interface: EntityService

TODO This probably doesn't belong here.

Specified by:

getPkForCountry in interface EntityService

_put

public EntityPutResult _put(@Nullable
 RebindService.Scope scope,
 RebindValue[] values)
                     throws UnresolvableUriException,
UriStoreException,
URISyntaxException,
InterruptedException,
EntityService.EntityPutResultException

Throws:

UnresolvableUriException

UriStoreException

URISyntaxException

InterruptedException

EntityService.EntityPutResultException

getValuesForLookupDropdown

public ArrayList<HashMap<String,String>> getValuesForLookupDropdown(String entityName)

Specified by:

getValuesForLookupDropdown in interface EntityService