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

Interface RebindService

All Known Implementing Classes:

RebindServiceImpl

public interface RebindService

Takes the rebind values as received from the client and sets the values on the entity.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	RebindService.Scope

Method Summary

Modifier and Type	Method	Description
void	rebind(RebindValue[] values)	Overloaded method where scope=null, fillNonNullable=true, fillEntityDefaults=true.
void	rebind(RebindValue[] values, @Nullable RebindService.Scope scope, boolean fillNonNullable, boolean fillEntityDefaults)	Rebinds the given values by finding/creating the affected entities and putting the values on them.
Collection<Entity>	rebindAndGetAffectedEntities(RebindValue[] values, @Nullable RebindService.Scope scope, boolean fillNonNullable, boolean fillEntityDefaults)	Returns all affected entities.
Entity	rebindAndGetEntity(RebindValue[] values, @Nullable RebindService.Scope scope, boolean fillNonNullable, boolean fillEntityDefaults, Predicate<Entity> predicate)	Selects the returned entity with a predicate.
Entity	rebindAndGetEntity(RebindValue[] values, @Nullable RebindService.Scope scope, String expectedEntityType)	Overloaded method where fillNonNullable=true, fillEntityDefaults=true.
Entity	rebindAndGetEntity(RebindValue[] values, @Nullable RebindService.Scope scope, String expectedEntityType, boolean fillNonNullable, boolean fillEntityDefaults)	Same as rebind(ch.tocco.nice2.netui.api.bind.entity.RebindValue[], ch.tocco.nice2.netui.api.bind.entity.RebindService.Scope, boolean, boolean) but also returns the "primary" Entity.
Entity	rebindAndGetEntity(RebindValue[] values, String expectedEntityType)	Same as rebind(ch.tocco.nice2.netui.api.bind.entity.RebindValue[], ch.tocco.nice2.netui.api.bind.entity.RebindService.Scope, boolean, boolean) but also returns the "primary" Entity.
Entity	rebindAndGetEntity(RebindValue[] values, String expectedEntityType, boolean fillNonNullable, boolean fillEntityDefaults)	Same as rebind(ch.tocco.nice2.netui.api.bind.entity.RebindValue[], ch.tocco.nice2.netui.api.bind.entity.RebindService.Scope, boolean, boolean) but also returns the "primary" Entity.
Entity	rebindAndGetEntityOneOfExpectedTypes(RebindValue[] values, @Nullable RebindService.Scope scope, boolean fillNonNullable, boolean fillEntityDefaults, String... expectedEntityTypes)	Same as rebindAndGetEntity(ch.tocco.nice2.netui.api.bind.entity.RebindValue[], java.lang.String) but returns the first Entity found in one of the expected types.
Entity	rebindAndGetEntityOneOfExpectedTypes(RebindValue[] values, @Nullable RebindService.Scope scope, String... expectedEntityTypes)	Overloaded method where fillNonNullable=true, fillEntityDefaults=true.
Entity	rebindAndGetEntityOneOfExpectedTypes(RebindValue[] values, String... expectedEntityTypes)	Overloaded method where fillNonNullable=true, fillEntityDefaults=true.

Method Details

rebindAndGetEntity

Entity rebindAndGetEntity(RebindValue[] values,
 String expectedEntityType)
                   throws UnresolvableUriException,
UriStoreException,
URISyntaxException,
RebindException

Same as rebind(ch.tocco.nice2.netui.api.bind.entity.RebindValue[], ch.tocco.nice2.netui.api.bind.entity.RebindService.Scope, boolean, boolean) but also returns the "primary" Entity.

Returns:

The first Entity of type expectedEntityType. If there could be more then one then you may wish to either use your own listeners to get what you need, or refactor/add functionality.

Throws:

RebindException - For example if there is no Entity touched of the expectedEntityType.

UnresolvableUriException

UriStoreException

URISyntaxException

rebindAndGetEntity

Entity rebindAndGetEntity(RebindValue[] values,
 String expectedEntityType,
 boolean fillNonNullable,
 boolean fillEntityDefaults)
                   throws UnresolvableUriException,
UriStoreException,
URISyntaxException,
RebindException

Same as rebind(ch.tocco.nice2.netui.api.bind.entity.RebindValue[], ch.tocco.nice2.netui.api.bind.entity.RebindService.Scope, boolean, boolean) but also returns the "primary" Entity.

Returns:

The first Entity of type expectedEntityType. If there could be more then one then you may wish to either use your own listeners to get what you need, or refactor/add functionality.

Throws:

RebindException - For example if there is no Entity touched of the expectedEntityType.

UnresolvableUriException

UriStoreException

URISyntaxException

rebindAndGetEntity

Entity rebindAndGetEntity(RebindValue[] values,
 @Nullable
 @Nullable RebindService.Scope scope,
 String expectedEntityType,
 boolean fillNonNullable,
 boolean fillEntityDefaults)
                   throws UnresolvableUriException,
UriStoreException,
URISyntaxException,
RebindException

Same as rebind(ch.tocco.nice2.netui.api.bind.entity.RebindValue[], ch.tocco.nice2.netui.api.bind.entity.RebindService.Scope, boolean, boolean) but also returns the "primary" Entity.

Returns:

The first Entity of type expectedEntityType. If there could be more then one then you may wish to either use your own listeners to get what you need, or refactor/add functionality.

Throws:

RebindException - For example if there is no Entity touched of the expectedEntityType.

UnresolvableUriException

UriStoreException

URISyntaxException

rebindAndGetEntity

Entity rebindAndGetEntity(RebindValue[] values,
 @Nullable
 @Nullable RebindService.Scope scope,
 String expectedEntityType)
                   throws UnresolvableUriException,
UriStoreException,
URISyntaxException,
RebindException

Overloaded method where fillNonNullable=true, fillEntityDefaults=true.

Throws:

UnresolvableUriException

UriStoreException

URISyntaxException

RebindException

See Also:

• rebindAndGetEntity(RebindValue[], Scope, String, boolean, boolean)

rebindAndGetEntityOneOfExpectedTypes

Entity rebindAndGetEntityOneOfExpectedTypes(RebindValue[] values,
 @Nullable
 @Nullable RebindService.Scope scope,
 boolean fillNonNullable,
 boolean fillEntityDefaults,
 String... expectedEntityTypes)
                                     throws UnresolvableUriException,
UriStoreException,
URISyntaxException,
RebindException

Same as rebindAndGetEntity(ch.tocco.nice2.netui.api.bind.entity.RebindValue[], java.lang.String) but returns the first Entity found in one of the expected types. You have to manually check of which type the returned entity is.

Hint: This method is made for public forms where it is not clear what entity type will be affected resp. changed. Example: The user can change values of user entity and/or address entity and/or membership entity on the same form.

Returns:

The first Entity of one of the type expectedEntityTypes.

Throws:

RebindException - For example if there is no Entity touched one of the expectedEntityTypes.

UnresolvableUriException

UriStoreException

URISyntaxException

rebindAndGetEntityOneOfExpectedTypes

Entity rebindAndGetEntityOneOfExpectedTypes(RebindValue[] values,
 String... expectedEntityTypes)
                                     throws UnresolvableUriException,
UriStoreException,
URISyntaxException,
RebindException

Overloaded method where fillNonNullable=true, fillEntityDefaults=true.

Throws:

UnresolvableUriException

UriStoreException

URISyntaxException

RebindException

See Also:

• rebindAndGetEntityOneOfExpectedTypes(RebindValue[], Scope, boolean, boolean, String...)

rebindAndGetEntityOneOfExpectedTypes

Entity rebindAndGetEntityOneOfExpectedTypes(RebindValue[] values,
 @Nullable
 @Nullable RebindService.Scope scope,
 String... expectedEntityTypes)
                                     throws UnresolvableUriException,
UriStoreException,
URISyntaxException,
RebindException

Overloaded method where fillNonNullable=true, fillEntityDefaults=true.

Throws:

UnresolvableUriException

UriStoreException

URISyntaxException

RebindException

See Also:

• rebindAndGetEntityOneOfExpectedTypes(RebindValue[], Scope, boolean, boolean, String...)

rebindAndGetEntity

Entity rebindAndGetEntity(RebindValue[] values,
 @Nullable
 @Nullable RebindService.Scope scope,
 boolean fillNonNullable,
 boolean fillEntityDefaults,
 Predicate<Entity> predicate)
                   throws UnresolvableUriException,
UriStoreException,
URISyntaxException,
RebindException

Selects the returned entity with a predicate. Predicate must be true for exactly one entity in any case.

Throws:

UnresolvableUriException

UriStoreException

URISyntaxException

RebindException

rebindAndGetAffectedEntities

Collection<Entity> rebindAndGetAffectedEntities(RebindValue[] values,
 @Nullable
 @Nullable RebindService.Scope scope,
 boolean fillNonNullable,
 boolean fillEntityDefaults)
                                         throws UnresolvableUriException,
UriStoreException,
URISyntaxException,
RebindException

Returns all affected entities.

Throws:

UnresolvableUriException

UriStoreException

URISyntaxException

RebindException

rebind

void rebind(RebindValue[] values,
 @Nullable
 @Nullable RebindService.Scope scope,
 boolean fillNonNullable,
 boolean fillEntityDefaults)
     throws UnresolvableUriException,
UriStoreException,
URISyntaxException,
ObjectOutdatedException

Rebinds the given values by finding/creating the affected entities and putting the values on them.

You can still set up your own listeners (entity-creating etc).

Parameters:

scope - Do not pass null for scope 'copy', it is essential to know that scope.

fillNonNullable - Handles this case automatically for you.

fillEntityDefaults - Handles this case automatically for you.

Throws:

UnresolvableUriException

UriStoreException

URISyntaxException

ObjectOutdatedException

rebind

void rebind(RebindValue[] values)
     throws UnresolvableUriException,
UriStoreException,
URISyntaxException,
ObjectOutdatedException

Overloaded method where scope=null, fillNonNullable=true, fillEntityDefaults=true.

Throws:

UnresolvableUriException

UriStoreException

URISyntaxException

ObjectOutdatedException

See Also:

• rebind(RebindValue[], Scope, boolean, boolean)