atg.service.validator

Interface CollectionUpdateHelper<C extends java.util.Collection<I>,I>

All Superinterfaces:

ContainerUpdateHelper<C,I>

All Known Implementing Classes:

atg.service.validator.CollectionUpdateHelperImpl, RepositoryItemCollectionUpdateHelperImpl

public interface CollectionUpdateHelper<C extends java.util.Collection<I>,I>
extends ContainerUpdateHelper<C,I>

Created: October 03 2015

See Also:

AnotherClass

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
I	findMatchingTarget(java.lang.Object pSourceElement, C pTargetContainer, ValidatorContext<?> pContext) Find a match for pSourceObject in the collection pTargetCollection.
void	removeUnmatchedTargetValues(C pTargetCollection, java.util.Collection<I> pUnmatchedElements, ValidatorContext<?> pContext) Remove the unmatched element (pUnmatchedElements) from pTargetCollection.
void	setToSourceOrder(C pTargetCollection, java.util.List<I> pOrderedDestinationItems) Set the target collection to the source order.

Methods inherited from interface atg.service.validator.ContainerUpdateHelper

createMatchingTargetAlsoAdds, createMatchingTargetItem, createTargetContainer, createTargetContainerAlsoSetsAsProperty

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Method Detail

findMatchingTarget

I findMatchingTarget(java.lang.Object pSourceElement,
                     C pTargetContainer,
                     ValidatorContext<?> pContext)
              throws PropertyNotFoundException,
                     java.beans.IntrospectionException,
                     atg.core.exception.ItemNotFoundException

Find a match for pSourceObject in the collection pTargetCollection. Default implemention uses equals to find a match.

Parameters:

pSourceElement - the source object to try to find a match for

pTargetCollection - the target collection

Returns:

the match element of the target collection, if a match is found. Otherwise, return null.

Throws:

atg.core.exception.ItemNotFoundException

PropertyNotFoundException

java.beans.IntrospectionException

removeUnmatchedTargetValues

void removeUnmatchedTargetValues(C pTargetCollection,
                                 java.util.Collection<I> pUnmatchedElements,
                                 ValidatorContext<?> pContext)

Remove the unmatched element (pUnmatchedElements) from pTargetCollection. Default just calls pTargetCollection.removeAll(pUnmatchedElements).

Parameters:

pTargetCollection - the collection from which elements should be removed.

pUnmatchedElements - the unmatched elements to be removed

pContext - the update context.

setToSourceOrder

void setToSourceOrder(C pTargetCollection,
                      java.util.List<I> pOrderedDestinationItems)

Set the target collection to the source order. Typically only called if the validator (like ListUpdatingValidator) supports orderling of that target collection.

Parameters:

pTargetCollection - the target collection.

pOrderedDestinationItems - the destination items (should be the same items as in pTargetCollection) ordered in the same order they were matched in the source.