Package com.inductiveautomation.ignition.gateway.config

Interface ResourceReferenceDelegate<R>

All Known Implementing Classes:

DefaultResourceReferenceDelegate, ExtensionPointReferenceDelegate

public interface ResourceReferenceDelegate<R>

Part of a ResourceTypeMeta that provides a way to find references to other resources.

Method Summary

Modifier and Type	Method	Description
default Collection<ReferenceProperty<R>>	getReferenceProperties()
default Collection<Reference>	getReferences(ConfigurationManager manager, ResourcePath targetResource)	Deprecated, for removal: This API element is subject to removal in a future version. Deprecated since 8.3.2.
default Collection<ResourceReferences<R>>	getResourceReferences(ConfigurationManager manager, ResourcePath targetResource)	Finds any properties of any instance(s) of this resource type that reference the given resource.
static <X> ResourceReferenceDelegate<X>	none()
default boolean	resourceReferencesSupported()

Method Details

getReferences

@Deprecated(since="8.3.2",
            forRemoval=true)
default Collection<Reference> getReferences(ConfigurationManager manager,
 ResourcePath targetResource)

Deprecated, for removal: This API element is subject to removal in a future version.

Deprecated since 8.3.2. Targeted for removal in version 2027. Use getResourceReferences(ConfigurationManager, ResourcePath) instead.

Finds any properties of any instance(s) of this resource type that reference the given resource.

Returns:

A collection of property references that reference the given resource. These references also include the capability to generate a ChangeOperation needed to update the reference in the case of a rename operation.

See Also:

• Reference.updateReference(ResourcePath)

resourceReferencesSupported

default boolean resourceReferencesSupported()

Returns:

true if getResourceReferences(ConfigurationManager, ResourcePath) is supported and false if the deprecated getReferences(ConfigurationManager, ResourcePath) should be used.

getResourceReferences

default Collection<ResourceReferences<R>> getResourceReferences(ConfigurationManager manager,
 ResourcePath targetResource)

Finds any properties of any instance(s) of this resource type that reference the given resource.

Returns:

A collection of property references that reference the given resource. These references also include the capability to generate a ChangeOperation needed to update the reference in the case of a rename operation.

See Also:

• ResourceReference.updateReference(ResourcePath, DecodedResource)

getReferenceProperties

default Collection<ReferenceProperty<R>> getReferenceProperties()

Returns:

A collection of all reference properties for the resource type represented by this delegate.

none

static <X> ResourceReferenceDelegate<X> none()