Package de.espirit.firstspirit.access.store.templatestore.gom.lists

Interface GomIndexSource

All Superinterfaces:

GomElement, Serializable

public interface GomIndexSource
extends GomElement

Definition of a source for an index gadget.

Since:

5.2.23

Method Summary

Modifier and Type	Method	Description
@Nullable GomElement	configuration()	Provides an optional container for configuring the source.
<T> @NotNull DataAccessSession<T>	createSession(@NotNull SpecialistsBroker broker, boolean release)	Creates a session based on the definition and configuration of this source.
String	name()	Provides the name of the plug-in containing indexed entries.

Methods inherited from interface de.espirit.firstspirit.access.store.templatestore.gom.GomElement

getGomElementTag, getIncludeConfiguration, hasRepresentation, setGomElementTag, setIncludeConfiguration

Method Details

name

String name()

Provides the name of the plug-in containing indexed entries.

Returns:

The plug-in's name.

Since:

5.2.23

configuration

@Nullable
@Nullable GomElement configuration()

Provides an optional container for configuring the source.

Returns:

A configuration container.

Since:

5.2.23

createSession

@NotNull
<T> @NotNull DataAccessSession<T> createSession(@NotNull
 @NotNull SpecialistsBroker broker,
 boolean release)

Creates a session based on the definition and configuration of this source.

Type Parameters:

T - The type of data provided by the source.

Parameters:

broker - A broker providing contextual knowledge.

release - Indicates, whether to operate in release mode (if applicable wrt. the source).

Returns:

A new session.

Since:

5.2.23