Package de.espirit.firstspirit.client.access.editor.lists

Interface IndexAccessor

@NonExtendable
public interface IndexAccessor

Generation time accessor to the value of an index.

Since:

5.2.25

Method Summary

Modifier and Type	Method	Description
@NotNull List<String>	getIdentifiers()	Provides the list of identifiers as entered in the index component.
@NotNull List<DataSnippet>	getSnippets()	Provides a list of snippets corresponding to the entries of the original index component.
@NotNull List<?>	getValues()	Provides the list of values corresponding to the entries of the original index component.
boolean	isEmpty()	Indicates the index to be empty, i.e., it does not contain any entry.

Method Details

getIdentifiers

@ApiDoc(comment="Provides the list of identifiers as entered in the index component.",
        since="5.2.25")
@NotNull
@NotNull List<String> getIdentifiers()

Provides the list of identifiers as entered in the index component.

Returns:

A list of identifiers.

Since:

5.2.25

getValues

@ApiDoc(comment="Provides the list of values corresponding to the entries of the original index component.",
        since="5.2.25")
@NotNull
@NotNull List<?> getValues()

Provides the list of values corresponding to the entries of the original index component.

Returns:

A list of values.

Since:

5.2.25

getSnippets

@ApiDoc(comment="Provides a list of snippets corresponding to the entries of the original index component.",
        since="5.2.416")
@NotNull
@NotNull List<DataSnippet> getSnippets()

Provides a list of snippets corresponding to the entries of the original index component.

Returns:

A list of Snippets.

Since:

5.2.416

isEmpty

@ApiDoc(comment="Indicates the index to be empty, i.e., it does not contain any entry.",
        since="5.2.609")
boolean isEmpty()

Indicates the index to be empty, i.e., it does not contain any entry.

Returns:

true, if the index is empty.

Since:

5.2.609