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

Interface Repeater

All Known Subinterfaces:

ModifiableRepeater

All Known Implementing Classes:

AbstractRepeater, ModelAwareRepeater, ModelLessRepeater, ModifiableModelAwareRepeater, ModifiableModelLessRepeater

public interface Repeater

Interface for repeaters

Method Summary

Modifier and Type	Method and Description
void	copyTo(ModifiableRepeater repeater) Copies the current Repeater to the given ModifiableRepeater.
List<? extends RepeaterEntry>	getEntries() Retrieves the repeater entries, sorted by position
RepeaterEntry	getEntry(int position) Retrieves the repeater entry at the given position.
int	getSize() Retrieves the size of the repeater
boolean	hasEntry(int position) Determines if the repeater has an entry at the given position.

Method Detail

getEntries

List<? extends RepeaterEntry> getEntries()

Retrieves the repeater entries, sorted by position

Returns:

the repeater entries

getEntry

RepeaterEntry getEntry(int position)

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)

Parameters:

position - the position of the entry to retrieve

Returns:

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

getSize

int getSize()

Retrieves the size of the repeater

Returns:

the size of the repeater

hasEntry

boolean hasEntry(int position)

Determines if the repeater has an 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)

Parameters:

position - the position

Returns:

true if the repeater has an entry at the given position, false otherwise

copyTo

void copyTo(ModifiableRepeater repeater)
     throws UndefinedItemPathException,
            BadItemTypeException,
            UnknownTypeException,
            NotUniqueTypeException

Copies the current Repeater to the given ModifiableRepeater.

Parameters:

repeater - The destination repeater. Can not be null.

Throws:

UndefinedItemPathException - if one of the copied data is not defined by the model of the destination ModifiableModelAwareRepeater

BadItemTypeException - if the type defined by the model of the destination ModifiableModelAwareRepeater doesn't match the copied value

UnknownTypeException - if there is no available type compatible with the copied value for the type extension point of the destination ModifiableModelLessRepeater

NotUniqueTypeException - if there is more than one available types compatibles with the copied value for the type extension point of the destination ModifiableModelLessRepeater