com.inductiveautomation.ignition.designer.model

Interface DesignerProjectContext

All Superinterfaces:

ProjectHolder, ResourceLockManager

All Known Subinterfaces:

DesignerContext

All Known Implementing Classes:

DesignerContextImpl, DesignerContextImpl.DesignerProjectHolderImpl, DesignerContextProxy

public interface DesignerProjectContext
extends ProjectHolder, ResourceLockManager

This extension of ProjectHolder contains methods used to alter the project.

Method Summary

Modifier and Type	Method and Description
java.util.UUID	addFolder(long newResourceId, java.lang.String moduleId, int scope, java.lang.String folderName, java.util.UUID parent) Adds a new folder under the given parent.
boolean	canEditResourceProtection() Checks whether or not the current logged in user can edit the protection bits of project resources.
void	deleteResource(long resourceId) Removes the resource from the current project
ProjectScope	getScope()
void	moveResource(long resourceId, java.util.UUID newParent) Moves the resource to a new parent.
void	structuredRename(long resourceId, java.lang.String newName) Attempts to rename the given project resource, respecting the requirement that the name be unique amongst siblings (with respect to the folder structure)
void	updateResource(long id, byte[] data) Convenience call that updates only the serialized bytes of a project resource, leaving all other parameters intact.
void	updateResource(ProjectResource resource) Adds or updates the given project resource

Methods inherited from interface com.inductiveautomation.ignition.client.model.ProjectHolder

addProjectChangeListener, applyDiff, getProject, removeProjectChangeListener

Methods inherited from interface com.inductiveautomation.ignition.client.gateway_interface.ResourceLockManager

hasLock, isLockModified, isLockOpen, newResourceId, releaseLock, requestLock, requestLockQuietly, synchLocks, updateLock

Method Detail

getScope

ProjectScope getScope()

updateResource

void updateResource(long id,
                    byte[] data)

Convenience call that updates only the serialized bytes of a project resource, leaving all other parameters intact.

updateResource

void updateResource(ProjectResource resource)

Adds or updates the given project resource

deleteResource

void deleteResource(long resourceId)

Removes the resource from the current project

canEditResourceProtection

boolean canEditResourceProtection()
                           throws GatewayException

Checks whether or not the current logged in user can edit the protection bits of project resources. Note: RPC call to gateway.

Throws:

GatewayException

structuredRename

void structuredRename(long resourceId,
                      java.lang.String newName)
               throws java.lang.IllegalArgumentException

Attempts to rename the given project resource, respecting the requirement that the name be unique amongst siblings (with respect to the folder structure)

Parameters:

resourceId - The ID of the resource to rename

newName - The new name

Throws:

java.lang.IllegalArgumentException - Thrown when the name is not unique.

moveResource

void moveResource(long resourceId,
                  java.util.UUID newParent)

Moves the resource to a new parent. If the name is already in use by a child of that parent, the resource will be renamed automatically.

addFolder

java.util.UUID addFolder(long newResourceId,
                         java.lang.String moduleId,
                         int scope,
                         java.lang.String folderName,
                         java.util.UUID parent)

Adds a new folder under the given parent. If there is already a child with the given name, the name will be automatically modified

Returns:

the UUID of the new folder