Package com.onshape.api.requests

Class AppElementsUpdateElementRequest.Builder

java.lang.Object

com.onshape.api.requests.AppElementsUpdateElementRequest.Builder

Enclosing class:

AppElementsUpdateElementRequest

public static final class AppElementsUpdateElementRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
AppElementsUpdateElementResponse	call(OnshapeDocument document)	Calls updateElement method, Update an app element
AppElementsUpdateElementResponse	call(String did, String wid, String eid)	Calls updateElement method, Update an app element
AppElementsUpdateElementRequestChanges[]	changes()	Get List of changes to make to the application element
AppElementsUpdateElementRequest.Builder	changes(AppElementsUpdateElementRequestChanges[] value)	Set List of changes to make to the application element
String	description()	Get Description of the change being made, for history tracking
AppElementsUpdateElementRequest.Builder	description(String value)	Set Description of the change being made, for history tracking
Map	jsonTreeEdit()	Get A change to the JSON tree encoded as a BTJEdit
AppElementsUpdateElementRequest.Builder	jsonTreeEdit(Map value)	Set A change to the JSON tree encoded as a BTJEdit
String	parentChangeId()	Get Id of the last change made by this application to this element
AppElementsUpdateElementRequest.Builder	parentChangeId(String value)	Set Id of the last change made by this application to this element
String	transactionId()	Get Id of transaction in which the update should be performed
AppElementsUpdateElementRequest.Builder	transactionId(String value)	Set Id of transaction in which the update should be performed

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

transactionId

public final String transactionId()

Get Id of transaction in which the update should be performed

Returns:

Id of transaction in which the update should be performed

transactionId

public final AppElementsUpdateElementRequest.Builder transactionId(String value)

Set Id of transaction in which the update should be performed

Parameters:

value - Id of transaction in which the update should be performed

Returns:

the Builder object.

parentChangeId

public final String parentChangeId()

Get Id of the last change made by this application to this element

Returns:

Id of the last change made by this application to this element

parentChangeId

public final AppElementsUpdateElementRequest.Builder parentChangeId(String value)

Set Id of the last change made by this application to this element

Parameters:

value - Id of the last change made by this application to this element

Returns:

the Builder object.

description

public final String description()

Get Description of the change being made, for history tracking

Returns:

Description of the change being made, for history tracking

description

public final AppElementsUpdateElementRequest.Builder description(String value)

Set Description of the change being made, for history tracking

Parameters:

value - Description of the change being made, for history tracking

Returns:

the Builder object.

changes

public final AppElementsUpdateElementRequestChanges[] changes()

Get List of changes to make to the application element

Returns:

List of changes to make to the application element

changes

public final AppElementsUpdateElementRequest.Builder changes(AppElementsUpdateElementRequestChanges[] value)

Set List of changes to make to the application element

Parameters:

value - List of changes to make to the application element

Returns:

the Builder object.

jsonTreeEdit

public final Map jsonTreeEdit()

Get A change to the JSON tree encoded as a BTJEdit

Returns:

A change to the JSON tree encoded as a BTJEdit

jsonTreeEdit

public final AppElementsUpdateElementRequest.Builder jsonTreeEdit(Map value)

Set A change to the JSON tree encoded as a BTJEdit

Parameters:

value - A change to the JSON tree encoded as a BTJEdit

Returns:

the Builder object.

call

public final AppElementsUpdateElementResponse call(String did,
                                                   String wid,
                                                   String eid)
                                            throws OnshapeException

Calls updateElement method, Update an app element

The BTJEdit encoding is as follows:

An edit is one of

* Deletion: { 'btType' : 'BTJEditDelete-1992', 'path' : path }

* Insertion: { 'btType' : 'BTJEditInsert-2523', 'path' : path, 'value' : newValue }

* Change: { 'btType' : 'BTJEditChange-2636', 'path' : path, 'value' : newValue }

* Move: { 'btType' : 'BTJEditMove-3245', 'sourcePath' : path, 'destinationPath' : path }

* List: { 'btType' : 'BTJEditList-2707', 'edits' : [ edit1, edit2, ...] }

Where edit1, edit2, etc. are zero or more edits, newValue is any JSON, and path is:

{ 'btType' : 'BTJPath-3073', 'startNode' : startNode, 'path' : [ pathElement1, pathElement2, ...] }

where startNode is a string that is either empty or a nodeId of a node in the tree and pathElement is one of:

* Key: { 'btType' : 'BTJPathKey-3221', 'key' : string }

* Index: { 'btType' : 'BTJPathIndex-1871', 'index' : integer }

Parameters:

did - Document ID

wid - Workspace ID

eid - Element ID

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error

call

public final AppElementsUpdateElementResponse call(OnshapeDocument document)
                                            throws OnshapeException

Calls updateElement method, Update an app element

The BTJEdit encoding is as follows:

An edit is one of

* Deletion: { 'btType' : 'BTJEditDelete-1992', 'path' : path }

* Insertion: { 'btType' : 'BTJEditInsert-2523', 'path' : path, 'value' : newValue }

* Change: { 'btType' : 'BTJEditChange-2636', 'path' : path, 'value' : newValue }

* Move: { 'btType' : 'BTJEditMove-3245', 'sourcePath' : path, 'destinationPath' : path }

* List: { 'btType' : 'BTJEditList-2707', 'edits' : [ edit1, edit2, ...] }

Where edit1, edit2, etc. are zero or more edits, newValue is any JSON, and path is:

{ 'btType' : 'BTJPath-3073', 'startNode' : startNode, 'path' : [ pathElement1, pathElement2, ...] }

where startNode is a string that is either empty or a nodeId of a node in the tree and pathElement is one of:

* Key: { 'btType' : 'BTJPathKey-3221', 'key' : string }

* Index: { 'btType' : 'BTJPathIndex-1871', 'index' : integer }

Parameters:

document - Document object from Onshape URL.

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error