atg.service.validator

Interface ContainerUpdateHelper<C,I>

All Known Subinterfaces:

CollectionUpdateHelper<C,I>, MapUpdateHelper<C,I>

All Known Implementing Classes:

atg.service.validator.CollectionUpdateHelperImpl, atg.service.validator.ContainerUpdateHelperImpl, RepositoryItemCollectionUpdateHelperImpl

public interface ContainerUpdateHelper<C,I>

An interface for a helper that can be used a map or collection UpdatingValidator (see CollectionUpdateHelper for a few collection-specific extensions).

Created: October 02 2015

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Method Summary

Modifier and Type	Method and Description
boolean	createMatchingTargetAlsoAdds(C pTargetContainer, ValidatorContext<?> pContext) Create a target item.
I	createMatchingTargetItem(java.lang.Object pSourceIndexOrKey, java.lang.Object pSourceItem, C pTargetContainer, ValidatorContext<?> pContext) Create a target item.
C	createTargetContainer(java.lang.String pPropertyName, java.lang.Object pTarget, ValidatorContext<?> pContext) Create the target container (Collection or Map).
boolean	createTargetContainerAlsoSetsAsProperty(C pTargetContainer, ValidatorContext<?> pContext) Whether a created target container should be set as a property.

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Method Detail

createTargetContainer

C createTargetContainer(java.lang.String pPropertyName,
                        java.lang.Object pTarget,
                        ValidatorContext<?> pContext)

Create the target container (Collection or Map). Invoked when the target container property is null.

Parameters:

pPropertyName - the target property name

pTarget - the target owning bean

pContext - the current validation context.

Returns:

the created target container.

createTargetContainerAlsoSetsAsProperty

boolean createTargetContainerAlsoSetsAsProperty(C pTargetContainer,
                                                ValidatorContext<?> pContext)

Whether a created target container should be set as a property.

Parameters:

pTargetContainer - the newly created target container.

pContext - the current validator context.

createMatchingTargetItem

I createMatchingTargetItem(java.lang.Object pSourceIndexOrKey,
                           java.lang.Object pSourceItem,
                           C pTargetContainer,
                           ValidatorContext<?> pContext)

Create a target item. For a collection, this method may be called to create an element of the collection. For a Map, this method may be called to create the value of a map.

Parameters:

pSourceIndexOrKey - for a collection, the current source index. For a map, the current source key.

pSourceItem - the source item (for a collection, an item in the source collection, for a Map, a value from the map) to create a target equavilent of

pTargetContainer - the target Collection or Map.

Returns:

a matching target item, or null if one could not be created.

createMatchingTargetAlsoAdds

boolean createMatchingTargetAlsoAdds(C pTargetContainer,
                                     ValidatorContext<?> pContext)

Create a target item. For a collection, this method may be called to create an element of the collection. For a Map, this method may be called to create the value of a map.

Parameters:

pSourceIndexOrKey - the source index (for a collection) or key (for a map) to create a target equavilent of.

pSourceItem - the source item (for a collection, an item in the source collection, for a Map, a value from the map) to create a target equavilent of

pTargetContainer - the target Collection or Map.

Returns:

a matching target item, or null if one could not be created.