Package com.onshape.api.requests

Class AppElementsCommitTransactionsRequest.Builder

java.lang.Object

com.onshape.api.requests.AppElementsCommitTransactionsRequest.Builder

Enclosing class:

AppElementsCommitTransactionsRequest

public static final class AppElementsCommitTransactionsRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
Boolean	allowMerge()	Get If false, return an error in the case of concurrency, even if changes could be merged.
AppElementsCommitTransactionsRequest.Builder	allowMerge(Boolean value)	Set If false, return an error in the case of concurrency, even if changes could be merged.
AppElementsCommitTransactionsResponse	call(OnshapeDocument document)	Calls commitTransactions method, Commits transactions (Merges multiple transactions into one microversion.) Either all of the transactions will be committed in a single microversion or none will be committed if the call raises an error.
AppElementsCommitTransactionsResponse	call(String did, String wid)	Calls commitTransactions method, Commits transactions (Merges multiple transactions into one microversion.) Either all of the transactions will be committed in a single microversion or none will be committed if the call raises an error.
String	description()	Get Description of the change being made, for history tracking
AppElementsCommitTransactionsRequest.Builder	description(String value)	Set Description of the change being made, for history tracking
String[]	transactionIds()	Get Ids of all transactions to commit.
AppElementsCommitTransactionsRequest.Builder	transactionIds(String[] value)	Set Ids of all transactions to commit.

Methods inherited from class java.lang.Object

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

Method Detail

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

allowMerge

public final Boolean allowMerge()

Get If false, return an error in the case of concurrency, even if changes could be merged. Default is true.

Returns:

If false, return an error in the case of concurrency, even if changes could be merged. Default is true.

allowMerge

public final AppElementsCommitTransactionsRequest.Builder allowMerge(Boolean value)

Set If false, return an error in the case of concurrency, even if changes could be merged. Default is true.

Parameters:

value - If false, return an error in the case of concurrency, even if changes could be merged. Default is true.

Returns:

the Builder object.

transactionIds

public final String[] transactionIds()

Get Ids of all transactions to commit.

Returns:

Ids of all transactions to commit.

transactionIds

public final AppElementsCommitTransactionsRequest.Builder transactionIds(String[] value)

Set Ids of all transactions to commit.

Parameters:

value - Ids of all transactions to commit.

Returns:

the Builder object.

call

public final AppElementsCommitTransactionsResponse call(String did,
                                                        String wid)
                                                 throws OnshapeException

Calls commitTransactions method, Commits transactions (Merges multiple transactions into one microversion.) Either all of the transactions will be committed in a single microversion or none will be committed if the call raises an error.

Parameters:

did - Document ID

wid - Workspace ID

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error

call

public final AppElementsCommitTransactionsResponse call(OnshapeDocument document)
                                                 throws OnshapeException

Calls commitTransactions method, Commits transactions (Merges multiple transactions into one microversion.) Either all of the transactions will be committed in a single microversion or none will be committed if the call raises an error.

Parameters:

document - Document object from Onshape URL.

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error