Package com.onshape.api.requests

Class AppElementsStartTransactionRequest.Builder

java.lang.Object

com.onshape.api.requests.AppElementsStartTransactionRequest.Builder

Enclosing class:

AppElementsStartTransactionRequest

public static final class AppElementsStartTransactionRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
AppElementsStartTransactionResponse	call(OnshapeDocument document)	Calls startTransaction method, Start a transaction (creates a microbranch)
AppElementsStartTransactionResponse	call(String did, String wid, String eid)	Calls startTransaction method, Start a transaction (creates a microbranch)
String	description()	Get Description of the change being made, for history tracking
AppElementsStartTransactionRequest.Builder	description(String value)	Set Description of the change being made, for history tracking
String	parentChangeId()	Get Id of the last change made by this application to this element
AppElementsStartTransactionRequest.Builder	parentChangeId(String value)	Set Id of the last change made by this application to this element

Methods inherited from class java.lang.Object

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

Method Detail

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 AppElementsStartTransactionRequest.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 AppElementsStartTransactionRequest.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.

call

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

Calls startTransaction method, Start a transaction (creates a microbranch)

Parameters:

did - Document ID

wid - Workspace ID

eid - Element ID

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error

call

public final AppElementsStartTransactionResponse call(OnshapeDocument document)
                                               throws OnshapeException

Calls startTransaction method, Start a transaction (creates a microbranch)

Parameters:

document - Document object from Onshape URL.

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error