Package de.espirit.firstspirit.access.editor

Interface Associate

public interface Associate

Definition of an associate for adding to some index.

Since:

5.2.12

Method Summary

Modifier and Type	Method	Description
@Nullable FormData	getFormData()	Provides the form data to be indexed for this associate.
@NotNull String	getIndexTerm()	Provides the term to be written identifying the associate in the index.
@NotNull Object	getType()	Provides the associate's type.

Method Details

getType

@NotNull
@NotNull Object getType()

Provides the associate's type.

Returns:

The type of the associate.

Since:

5.2.12

getIndexTerm

@NotNull
@NotNull String getIndexTerm()

Provides the term to be written identifying the associate in the index.

Returns:

The index term.

Since:

5.2.12

getFormData

@Nullable
@Nullable FormData getFormData()

Provides the form data to be indexed for this associate.

Returns:

The form data or null, if no data is to be indexed.

Since:

5.2.12