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

Interface Catalog.Card

Enclosing interface:

Catalog

@NonExtendable
public static interface Catalog.Card

Single entry of a catalog providing some meta data on the item and a reference to the item itself.

Since:

5.2.6

Method Summary

Modifier and Type	Method	Description
@NotNull UUID	getId()	Provides the unique identifier of this card.
@NotNull FormData	getItem()	Provides the item referred to with this card.
@NotNull Template	getTemplate()	Provides the template this card's item is based upon.
void	loadItem(@NotNull FormData formData)	Loads the data from the given item into this card.

Method Details

getId

@ApiDoc(comment="Provides the card\'s unique identifier.",
        since="5.2.181202")
@NotNull
@NotNull UUID getId()

Provides the unique identifier of this card.

Returns:

The card's identifier.

Since:

5.2.181202

getTemplate

@ApiDoc(comment="Provides the template this card\'s item is based upon.",
        since="5.2.6")
@NotNull
@NotNull Template getTemplate()
                       throws ElementUnavailableException

Provides the template this card's item is based upon.

Returns:

The template.

Throws:

ElementUnavailableException - If the element is not available.

Since:

5.2.6

getItem

@ApiDoc(comment="Provides the item referred to with this card.",
        since="5.2.6")
@NotNull
@NotNull FormData getItem()

Provides the item referred to with this card.

Returns:

The referred item.

Since:

5.2.6

loadItem

@ApiDoc(comment="Loads the data from the given item into this card.",
        since="5.2.13")
void loadItem(@NotNull
 @NotNull FormData formData)

Loads the data from the given item into this card.

Parameters:

formData - The item providing as source for data.

Since:

5.2.13