Update Jobs

Table of Contents

Every job here is the data of an UpdateJob request, whose envelope the Resource Access API chapter describes.

CopyResourceTransferData

This class represents a job to serialize resources (nodes and packages) for clipboard transfer. It extends WriteJob and returns a string containing the serialized transfer data.

Request Type Required
nodes Node[] yes
statements Statement[] yes
pkgs Package[] yes
cut boolean yes
Response Type Required
datas TransferData[] yes

CopyTextContentTransferData

Copy text content

Request Type Required
node Node yes
range TextRange yes
cut boolean yes
Response Type Required
datas TransferData[] yes
content TextContent yes
selection TextRange yes

CreatePackage

Update the package name

Request Type Required
parent Package yes
simpleName string yes

Response - the job answers with its type only.

CreateResource

Create and initialize a new resource

Request Type Required
pkg Package yes
typeof Node yes
owner Node no
predicate Node no
decorated Node no
position Statement no
name string no
after boolean no
Response Type Required
node Node yes
statement Statement no

DeletePackage

Delete a specific package

Request Type Required
pkg Package yes

Response - the job answers with its type only.

DeleteResource

Deleting a resource and all the instructions it contains

Request Type Required
node Node yes
pkg Package yes

Response - the job answers with its type only.

DeleteResources

Deleting a resource and all the instructions it contains

Request Type Required
packagedResources PackagedResource[] yes

Response - the job answers with its type only.

DisposeStatements

Deleting a resource and all the instructions it contains

Request Type Required
statements Statement[] yes

Response - the job answers with its type only.

ExecuteModelMenuItem

Update the name from the node

Request Type Required
node PackagedResource yes
item Node yes
parent object no

Response - the job answers with its type only.

MovePackages

Moving packages

Request Type Required
pkgs Package[] yes
pkg Package no

Response - the job answers with its type only.

MoveResources

Moving resources

Request Type Required
resources PackagedResource[] yes
pkg Package no
subjectPredicate SubjectPredicate no

Response - the job answers with its type only.

MoveStatements

Moves statements one position up or down inside the property they belong to. Where they land is the server’s answer, not the client’s: which statements the property holds - and for a decorating relation, which of them belong together - is known there, and the move is one write job instead of a remove and an add that could fail apart. Several statements move in the order they are given, which has to be the order they are shown in.

Request Type Required
statements Statement[] yes
direction string yes

Response - the job answers with its type only.

PasteResourceTransferData

This class represents a job for pasting (importing) clipboard transfer data into the workspace. It extends WriteJob and performs the paste operation using the provided data and context.

Request Type Required
datas TransferData[] yes
pkg Package yes
node Node no
predicate Node no
Response Type Required
nodes Node[] yes

PasteTextContentTransferData

Paste transfer data to text content

Request Type Required
datas TransferData[] yes
node Node no
range TextRange yes
Response Type Required
selection TextRange yes
content TextContent yes

SortProperty

Sorts the statements of a resource by given sortKey.

Request Type Required
subjectPredicate SubjectPredicate yes
key Node yes

Response - the job answers with its type only.

UpdateByPatch

This update job is used to update the resource pool by patch.

Request Type Required
patch Patch yes

Response - the job answers with its type only.

UpdateName

This update job is used to set the name of a named resource.

Request Type Required
node Node yes
name string yes

Response - the job answers with its type only.

UpdatePackageName

Update the package name

Request Type Required
pkg Package yes
name string yes

Response - the job answers with its type only.

UpdateTextContent

This update job is used to update the text container.

Request Type Required
node Node yes
patch TextPatch yes
range TextRange no
Response Type Required
content TextContent yes