Package com.onshape.api.requests

Class AppElementsDeleteReferenceRequest.Builder

java.lang.Object

com.onshape.api.requests.AppElementsDeleteReferenceRequest.Builder

Enclosing class:

AppElementsDeleteReferenceRequest

public static final class AppElementsDeleteReferenceRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
AppElementsDeleteReferenceResponse	call(OnshapeDocument document, String rid)	Calls deleteReference method, Delete an app element reference
AppElementsDeleteReferenceResponse	call(String rid, String did, String wid, String eid)	Calls deleteReference method, Delete an app element reference
String	description()	Get Description of the deletion operation for history
AppElementsDeleteReferenceRequest.Builder	description(String value)	Set Description of the deletion operation for history
String	parentChangeId()	Get Id of the last change made by this application to this element
AppElementsDeleteReferenceRequest.Builder	parentChangeId(String value)	Set Id of the last change made by this application to this element
String	transactionId()	Get Id of the transaction to commit
AppElementsDeleteReferenceRequest.Builder	transactionId(String value)	Set Id of the transaction to commit

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

transactionId

public final String transactionId()

Get Id of the transaction to commit

Returns:

Id of the transaction to commit

transactionId

public final AppElementsDeleteReferenceRequest.Builder transactionId(String value)

Set Id of the transaction to commit

Parameters:

value - Id of the transaction to commit

Returns:

the Builder object.

description

public final String description()

Get Description of the deletion operation for history

Returns:

Description of the deletion operation for history

description

public final AppElementsDeleteReferenceRequest.Builder description(String value)

Set Description of the deletion operation for history

Parameters:

value - Description of the deletion operation for history

Returns:

the Builder object.

call

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

Calls deleteReference method, Delete an app element reference

Parameters:

rid - The id of the reference to be deleted

did - Document ID

wid - Workspace ID

eid - Element ID

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error

call

public final AppElementsDeleteReferenceResponse call(OnshapeDocument document,
                                                     String rid)
                                              throws OnshapeException

Calls deleteReference method, Delete an app element reference

Parameters:

document - Document object from Onshape URL.

rid - The id of the reference to be deleted

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error