Package de.espirit.firstspirit.agency

Interface PreviewUrlAgent

public interface PreviewUrlAgent

An Agent that is able to create preview urls for StoreElements.

Since:

5.2.190105

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	PreviewUrlAgent.ContentProducerPreviewUrlBuilder	The preview url builder for ContentProducers like Page, PageRef or DocumentGroup nodes.
static interface	PreviewUrlAgent.MediaPreviewUrlBuilder	The preview url builder for Media nodes.
static interface	PreviewUrlAgent.PreviewUrlBuilder<T>	Basic preview url builder definition.

Field Summary

Fields

Modifier and Type	Field	Description
static final SpecialistType<PreviewUrlAgent>	TYPE	The agent's technical type to be used to request the agent from a SpecialistsBroker.

Method Summary

Modifier and Type	Method	Description
@NotNull PreviewUrlAgent.ContentProducerPreviewUrlBuilder	getContentProducerBuilder()	Returns a preview url builder for ContentProducer type StoreElements.
@NotNull PreviewUrlAgent.MediaPreviewUrlBuilder	getMediaBuilder()	Returns a preview url builder for Media type StoreElements.

Field Details

TYPE

static final SpecialistType<PreviewUrlAgent> TYPE

The agent's technical type to be used to request the agent from a SpecialistsBroker.

Since:

5.2.190105

Method Details

getMediaBuilder

@Contract("-> new")
@NotNull
@NotNull PreviewUrlAgent.MediaPreviewUrlBuilder getMediaBuilder()

Returns a preview url builder for Media type StoreElements.

Returns:

A client type respecting url builder.

Since:

5.2.190105

getContentProducerBuilder

@Contract("-> new")
@NotNull
@NotNull PreviewUrlAgent.ContentProducerPreviewUrlBuilder getContentProducerBuilder()

Returns a preview url builder for ContentProducer type StoreElements.

Returns:

A client type respecting url builder.

Since:

5.2.190105