de.espirit.firstspirit.client.access.editor
Interface ReferenceConstructionAgent

public interface ReferenceConstructionAgent

Agent providing means to create reference holding containers for store elements, data sets, and external URLs.

Since:

4.2.414

See Also:

ReferenceTransformationAgent, ReferenceHolder

Field Summary

static SpecialistType<ReferenceConstructionAgent>

TYPE Agent providing means to create reference holding containers for store elements, data sets, and external URLs.

Method Summary

StoreElementReferenceHolder	create(IDProvider element, String remoteConfigName) Create an element referencing container from a given id providing store element.
ExternalReferenceHolder	create(String url, String category) Create an external referencing container from a given URL.

Field Detail

TYPE

static final SpecialistType<ReferenceConstructionAgent> TYPE

Agent providing means to create reference holding containers for store elements, data sets, and external URLs.

Since:

4.2.414

Method Detail

create

@NotNull
StoreElementReferenceHolder create(@NotNull
                                           IDProvider element,
                                           @Nullable
                                           String remoteConfigName)
                                   throws IllegalArgumentException

Create an element referencing container from a given id providing store element. If the element originates from a remote project, the name of the according remote configuration must be given.

Note: If the given element is of type Dataset, it must originate from a content source. This is met if the dataset is returned by a SelectStoreElementOperation.

Parameters:

element - The store element.

remoteConfigName - Name of the remote configuration.

Returns:

A container referencing the given element.

Throws:

IllegalArgumentException - If a the given element and/or remote information do not satisfy the requirements for building a reference container.

Since:

4.2.414

create

@NotNull
ExternalReferenceHolder create(@NotNull
                                       String url,
                                       @Nullable
                                       String category)

Create an external referencing container from a given URL.

Parameters:

url - A URL.

category - The category of the url - if null the default category "url" is used.

Returns:

A container referencing via URL.

Since:

4.2.414