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

Interface EntityService

All Known Implementing Classes:

EntityServiceImpl

public interface EntityService

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	EntityService.EntityFormDataException
static class	EntityService.EntityPutResultException

Method Summary

Modifier and Type	Method	Description
EntityFormData	getDataForForm(String formUri, String entityUri)	Returns the data for a form when bound to the entity specified.
AbstractFieldInfo[]	getDefaultValuesForForm(String formUri)
AbstractFieldInfo[]	getDefaultValuesForFormWithOverrides(String formUri, @Nullable DefaultValueOverride[] overrides)	Returns the default values for a form.
AbstractFieldInfo[]	getDefaultValuesForFormWithOverrides(String formUri, @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)	Asynchronously load options for a combo-box but only return SelectionFieldInfo.SelectionValues which come from the passed business units.
Map<String,String>	getPkForCountry(String iso3166)	TODO This probably doesn't belong here.
ArrayList<HashMap<String,String>>	getValuesForLookupDropdown(String entityName)
EntityPutResult	put(RebindValue[] values)	Deprecated. use putWithScope()
EntityPutResult	putWithScope(String scope, RebindValue[] values)	Stores the values.

Method Details

getDefaultValuesForForm

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

Throws:

UnresolvableUriException

UriStoreException

URISyntaxException

InterruptedException

CustomDataProviderException

See Also:

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

getDefaultValuesForFormWithOverrides

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

Returns the default values for a form.

Parameters:

formUri - 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

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

Returns the default values for a form.

Parameters:

formUri - 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

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

Throws:

URISyntaxException

UnresolvableUriException

UriStoreException

InterruptedException

getDataForForm

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

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

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

String getEntityDisplay(URI uri)
                 throws UnresolvableUriException,
UriStoreException

Returns the default display for an entity.

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

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

Deprecated.

use putWithScope()

Throws:

UnresolvableUriException

UriStoreException

RebindException

URISyntaxException

InterruptedException

CommitException

EntityService.EntityPutResultException

putWithScope

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

Stores the values.

Parameters:

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

Throws:

UnresolvableUriException

UriStoreException

RebindException

URISyntaxException

InterruptedException

CommitException

EntityService.EntityPutResultException

getPkForCountry

Map<String,String> getPkForCountry(String iso3166)
                            throws PersistException

TODO This probably doesn't belong here.

Throws:

PersistException

getValuesForLookupDropdown

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

getOptions

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

Asynchronously load options for a combo-box.

Parameters:

fieldName - name of the field

formName - name of the form

Returns:

a list of SelectionValues

Throws:

URISyntaxException - -

UriStoreException - -

UnresolvableUriException - -

getOptions

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

Asynchronously load options for a combo-box but only return SelectionFieldInfo.SelectionValues which come from the passed business units. If NULL is passed, it returns values from all business units. If two or more values have the same display value, the label of the business unit will be added in brackets. Example (Membership_type): BU1 has a membership type with the label `Member` BU2 has a membership type with the label `Member` The return value for each of these two membership types will be: - `Member (BU1.label)` - `Member (BU2.label)`

Throws:

PersistException

URISyntaxException

UriStoreException

UnresolvableUriException