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

Fields

Modifier and Type	Field and Description
static SpecialistType<ReferenceConstructionAgent>	TYPE Agent providing means to create reference holding containers for store elements, data sets, and external URLs.

Method Summary

Methods

Modifier and Type	Method and Description
IDProviderReferenceHolder	create(IDProvider element, String remoteConfigName) Create an element referencing container from a given id providing store element.
ExternalReferenceHolder	create(String resource, String category) Create an external referencing container from a given resource (e.g. an URL) and category.

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
IDProviderReferenceHolder 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 resource,
                                     @Nullable
                                     String category)

Create an external referencing container from a given resource (e.g. an URL) and category.

Parameters:

resource - an external resource.

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

Returns:

A container referencing via a resource identifier and a category.

Since:

4.2.414