Package com.onshape.api.requests

Class AppElementsResolveReferenceRequest.Builder

java.lang.Object

com.onshape.api.requests.AppElementsResolveReferenceRequest.Builder

Enclosing class:

AppElementsResolveReferenceRequest

public static final class AppElementsResolveReferenceRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
AppElementsResolveReferenceResponse	call(OnshapeDocument document, String rid)	Calls resolveReference method, Resolve an app element reference.
AppElementsResolveReferenceResponse	call(String rid, String did, WVM wvmType, String wvm, String eid)	Calls resolveReference method, Resolve an app element reference.
String	linkDocumentId()	Get Id of document that links to the document being accessed.
AppElementsResolveReferenceRequest.Builder	linkDocumentId(String value)	Set Id of document that links to the document being accessed.
String	parentChangeId()	Get Id of the change at which the reference should be retrieved Valid only when used with a workspaceId
AppElementsResolveReferenceRequest.Builder	parentChangeId(String value)	Set Id of the change at which the reference should be retrieved Valid only when used with a workspaceId
String	transactionId()	Get Id of the transaction in which the reference should be retrieved Valid only when used with a workspaceId
AppElementsResolveReferenceRequest.Builder	transactionId(String value)	Set Id of the transaction in which the reference should be retrieved Valid only when used with a workspaceId

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 the transaction in which the reference should be retrieved Valid only when used with a workspaceId

Returns:

Id of the transaction in which the reference should be retrieved Valid only when used with a workspaceId

transactionId

public final AppElementsResolveReferenceRequest.Builder transactionId(String value)

Set Id of the transaction in which the reference should be retrieved Valid only when used with a workspaceId

Parameters:

value - Id of the transaction in which the reference should be retrieved Valid only when used with a workspaceId

Returns:

the Builder object.

parentChangeId

public final String parentChangeId()

Get Id of the change at which the reference should be retrieved Valid only when used with a workspaceId

Returns:

Id of the change at which the reference should be retrieved Valid only when used with a workspaceId

parentChangeId

public final AppElementsResolveReferenceRequest.Builder parentChangeId(String value)

Set Id of the change at which the reference should be retrieved Valid only when used with a workspaceId

Parameters:

value - Id of the change at which the reference should be retrieved Valid only when used with a workspaceId

Returns:

the Builder object.

linkDocumentId

public final String linkDocumentId()

Get Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter.

Returns:

Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter.

linkDocumentId

public final AppElementsResolveReferenceRequest.Builder linkDocumentId(String value)

Set Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter.

Parameters:

value - Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter.

Returns:

the Builder object.

call

public final AppElementsResolveReferenceResponse call(String rid,
                                                      String did,
                                                      WVM wvmType,
                                                      String wvm,
                                                      String eid)
                                               throws OnshapeException

Calls resolveReference method, Resolve an app element reference. Refer to AppElements-resolveReferences if a bulk operation is required.

Parameters:

rid - The id of the reference to read

did - Document ID

wvmType - Type of Workspace, Version or Microversion

wvm - Workspace (w), Version (v) or Microversion (m) ID

eid - Element ID

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error

call

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

Calls resolveReference method, Resolve an app element reference. Refer to AppElements-resolveReferences if a bulk operation is required.

Parameters:

document - Document object from Onshape URL.

rid - The id of the reference to read

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error