Package org.ametys.cms.data.holder.group

Interface ModifiableIndexableRepeater

All Superinterfaces:

IndexableRepeater, ModifiableRepeater, Repeater

All Known Implementing Classes:

DefaultModifiableIndexableRepeater

public interface ModifiableIndexableRepeater
extends IndexableRepeater, ModifiableRepeater

Interface for modifiable indexable repeaters

Method Summary

Modifier and Type	Method	Description
ModifiableIndexableRepeaterEntry	addEntry()	Creates a Repeater entry at the last position.
ModifiableIndexableRepeaterEntry	addEntry(int position)	Creates a Repeater entry at the given position.
List<? extends ModifiableIndexableRepeaterEntry>	getEntries()	Retrieves the repeater entries, sorted by position
ModifiableIndexableRepeaterEntry	getEntry(int position)	Retrieves the repeater entry at the given position.
ModifiableIndexableDataHolder	getParentDataHolder()	Retrieves the parent of the current Repeater
ModifiableIndexableDataHolder	getRootDataHolder()	Retrieves the root DataHolder of the current repeater

Methods inherited from interface org.ametys.cms.data.holder.group.IndexableRepeater

indexData, indexData

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

getRepositoryData, moveEntries, removeEntries, removeEntry, synchronizeValues, synchronizeValues

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

copyTo, copyTo, dataToJSON, dataToJSON, dataToJSON, dataToJSON, dataToJSON, dataToJSON, dataToJSONForEdition, dataToSAX, dataToSAX, dataToSAX, dataToSAX, dataToSAX, dataToSAX, dataToSAXForEdition, getDifferences, getDifferences, getModel, getSize, hasDifferences, hasDifferences, hasEntry, hasToMoveEntries

Method Details

getEntries

List<? extends ModifiableIndexableRepeaterEntry> getEntries()

Description copied from interface: Repeater

Retrieves the repeater entries, sorted by position

Specified by:

getEntries in interface IndexableRepeater

Specified by:

getEntries in interface ModifiableRepeater

Specified by:

getEntries in interface Repeater

Returns:

the repeater entries

getEntry

ModifiableIndexableRepeaterEntry 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 IndexableRepeater

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

ModifiableIndexableRepeaterEntry 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

ModifiableIndexableRepeaterEntry 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

getParentDataHolder

ModifiableIndexableDataHolder getParentDataHolder()

Description copied from interface: Repeater

Retrieves the parent of the current Repeater

Specified by:

getParentDataHolder in interface IndexableRepeater

Specified by:

getParentDataHolder in interface ModifiableRepeater

Specified by:

getParentDataHolder in interface Repeater

Returns:

the parent of the current Repeater

getRootDataHolder

ModifiableIndexableDataHolder getRootDataHolder()

Description copied from interface: Repeater

Retrieves the root DataHolder of the current repeater

Specified by:

getRootDataHolder in interface IndexableRepeater

Specified by:

getRootDataHolder in interface ModifiableRepeater

Specified by:

getRootDataHolder in interface Repeater

Returns:

the root DataHolder