Package org.ametys.plugins.repository.data.holder.group

Interface ModifiableModelAwareRepeater

All Superinterfaces:

ModelAwareRepeater, ModifiableRepeater, Repeater

All Known Subinterfaces:

ModifiableIndexableRepeater

All Known Implementing Classes:

DefaultModifiableModelAwareRepeater

public interface ModifiableModelAwareRepeater
extends ModelAwareRepeater, ModifiableRepeater

Interface for modifiable model aware repeaters

Method Summary

Modifier and Type	Method	Description
ModifiableModelAwareRepeaterEntry	addEntry()	Creates a Repeater entry at the last position.
ModifiableModelAwareRepeaterEntry	addEntry(int position)	Creates a Repeater entry at the given position.
List<? extends ModifiableModelAwareRepeaterEntry>	getEntries()	Retrieves the repeater entries, sorted by position
ModifiableModelAwareRepeaterEntry	getEntry(int position)	Retrieves the repeater entry at the given position.
ModifiableModelAwareDataHolder	getParentDataHolder()	Retrieves the parent of the current Repeater
ModifiableModelAwareDataHolder	getRootDataHolder()	Retrieves the root DataHolder of the current repeater
default <T extends SynchronizationResult> T	synchronizeValues(ViewItemContainer viewItemContainer, SynchronizableRepeater repeaterValues)	Synchronizes the given values with each repeater's entry
<T extends SynchronizationResult> T	synchronizeValues(ViewItemContainer viewItemContainer, SynchronizableRepeater repeaterValues, SynchronizationContext context)	Synchronizes the given values with each repeater's entry

Methods inherited from interface org.ametys.plugins.repository.data.holder.group.ModelAwareRepeater

dataToJSON, dataToJSON, dataToJSON, dataToJSON, dataToSAX, dataToSAX, dataToSAX, dataToSAX, getModel

Methods inherited from interface org.ametys.plugins.repository.data.holder.group.ModifiableRepeater

getRepositoryData, moveEntries, removeEntries, removeEntry

Methods inherited from interface org.ametys.plugins.repository.data.holder.group.Repeater

copyTo, dataToJSON, dataToJSON, dataToSAX, dataToSAX, getSize, hasEntry

Method Details

getEntries

List<? extends ModifiableModelAwareRepeaterEntry> getEntries()

Description copied from interface: Repeater

Retrieves the repeater entries, sorted by position

Specified by:

getEntries in interface ModelAwareRepeater

Specified by:

getEntries in interface Repeater

Returns:

the repeater entries

getEntry

ModifiableModelAwareRepeaterEntry getEntry(int position)

Description copied from interface: Repeater

Retrieves the repeater entry at the given position. The position starts at index 1. The position can be an integer between 1 and the repeater size to get an entry from the beginning Or the position can an integer between 0 and - the repeater size to get an entry from the end (0 means at the end, -1 means before the last one and so on)

Specified by:

getEntry in interface ModelAwareRepeater

Specified by:

getEntry in interface ModifiableRepeater

Specified by:

getEntry in interface Repeater

Parameters:

position - the position of the entry to retrieve

Returns:

the repeater entry, null if there is no entry at this position

addEntry

ModifiableModelAwareRepeaterEntry addEntry()

Description copied from interface: ModifiableRepeater

Creates a Repeater entry at the last position.

Specified by:

addEntry in interface ModifiableRepeater

Returns:

the created entry

addEntry

ModifiableModelAwareRepeaterEntry addEntry(int position)
                                    throws IllegalArgumentException

Description copied from interface: ModifiableRepeater

Creates a Repeater entry at the given position. The position starts at index 1. The position can be an integer between 1 and the repeater size + 1 to insert an entry from the beginning Or the position can an integer between 0 and - the repeater size to insert an entry from the end (0 means at the end, -1 means before the last one and so on)

Specified by:

addEntry in interface ModifiableRepeater

Parameters:

position - The position of the new entry

Returns:

the created entry

Throws:

IllegalArgumentException - if the position is not between the negative and positive repeater size

synchronizeValues

default <T extends SynchronizationResult> T synchronizeValues(ViewItemContainer viewItemContainer,
 SynchronizableRepeater repeaterValues)
                                                       throws UndefinedItemPathException,
BadItemTypeException

Synchronizes the given values with each repeater's entry

Type Parameters:

T - the type of the SynchronizationResult

Parameters:

viewItemContainer - The ViewItemContainer containing all items to synchronize

repeaterValues - the values of the repeater to synchronize

Returns:

the SynchronizationResult

Throws:

UndefinedItemPathException - if an entry's key refers to a data that is not defined by the model

BadItemTypeException - if the type defined by the model of one entry's key doesn't match the corresponding value

synchronizeValues

<T extends SynchronizationResult> T synchronizeValues(ViewItemContainer viewItemContainer,
 SynchronizableRepeater repeaterValues,
 SynchronizationContext context)
                                               throws UndefinedItemPathException,
BadItemTypeException

Synchronizes the given values with each repeater's entry

Type Parameters:

T - the type of the SynchronizationResult

Parameters:

viewItemContainer - The ViewItemContainer containing all items to synchronize

repeaterValues - the values of the repeater to synchronize

context - the context of the synchronization

Returns:

the SynchronizationResult

Throws:

UndefinedItemPathException - if an entry's key refers to a data that is not defined by the model

BadItemTypeException - if the type defined by the model of one entry's key doesn't match the corresponding value

getParentDataHolder

ModifiableModelAwareDataHolder getParentDataHolder()

Description copied from interface: Repeater

Retrieves the parent of the current Repeater

Specified by:

getParentDataHolder in interface ModelAwareRepeater

Specified by:

getParentDataHolder in interface ModifiableRepeater

Specified by:

getParentDataHolder in interface Repeater

Returns:

the parent of the current Repeater

getRootDataHolder

ModifiableModelAwareDataHolder getRootDataHolder()

Description copied from interface: Repeater

Retrieves the root DataHolder of the current repeater

Specified by:

getRootDataHolder in interface ModelAwareRepeater

Specified by:

getRootDataHolder in interface ModifiableRepeater

Specified by:

getRootDataHolder in interface Repeater

Returns:

the root DataHolder