Package com.inductiveautomation.ignition.gateway.config.actions

Interface ResourceAction.Rename

All Superinterfaces:

ResourceAction

All Known Implementing Classes:

DefaultResourceActions.Rename

Enclosing interface:

ResourceAction

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public static non-sealed interface ResourceAction.Rename
extends ResourceAction

Nested Class Summary

Nested classes/interfaces inherited from interface com.inductiveautomation.ignition.gateway.config.actions.ResourceAction

ResourceAction.ContextObject, ResourceAction.Copy, ResourceAction.Create, ResourceAction.CreateRequest, ResourceAction.Delete, ResourceAction.DeleteRequest, ResourceAction.ListResources, ResourceAction.Modify, ResourceAction.ModifyRequest, ResourceAction.Move, ResourceAction.Read, ResourceAction.Rename

Method Summary

Modifier and Type	Method	Description
@NotNull StructuralModificationResponse	rename(ConfigurationManager manager, ResourceType resourceType, String name, String newName, ReferenceHandling referenceHandling, @Nullable String collection, ResourceAction.ContextObject contextObject)	Renames a named resource.

Method Details

rename

@NotNull
@NotNull StructuralModificationResponse rename(ConfigurationManager manager,
 ResourceType resourceType,
 String name,
 String newName,
 ReferenceHandling referenceHandling,
 @Nullable
 @Nullable String collection,
 ResourceAction.ContextObject contextObject)

Renames a named resource.

Parameters:

manager - The configuration manager to use for renaming the resource.

resourceType - The type of the resource to rename.

name - The current name of the resource.

newName - The new name for the resource.

referenceHandling - How to handle references to the renamed resource.

collection - The collection in which the resource resides, if applicable.

contextObject - The context object to associated with the change.

Returns:

A response indicating the result of the rename operation.