Package com.onshape.api.requests

Class AppElementsResolveReferencesRequest.Builder

java.lang.Object

com.onshape.api.requests.AppElementsResolveReferencesRequest.Builder

Enclosing class:

AppElementsResolveReferencesRequest

public static final class AppElementsResolveReferencesRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
AppElementsResolveReferencesResponse	call(OnshapeDocument document)	Calls resolveReferences method, Resolve references for an app element
AppElementsResolveReferencesResponse	call(String did, WVM wvmType, String wvm, String eid)	Calls resolveReferences method, Resolve references for an app element
String	linkDocumentId()	Get Id of document that links to the document being accessed.
AppElementsResolveReferencesRequest.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 references should be retrieved.
AppElementsResolveReferencesRequest.Builder	parentChangeId(String value)	Set Id of the change at which the references should be retrieved.
String	referenceIds()	Get A list of ids (comma-separated) of the references to resolve, or empty if all.
AppElementsResolveReferencesRequest.Builder	referenceIds(String value)	Set A list of ids (comma-separated) of the references to resolve, or empty if all.
String	transactionId()	Get Id of the transaction in which the references should be retrieved.
AppElementsResolveReferencesRequest.Builder	transactionId(String value)	Set Id of the transaction in which the references should be retrieved.

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 references should be retrieved. Valid only when used with a workspaceId

Returns:

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

transactionId

public final AppElementsResolveReferencesRequest.Builder transactionId(String value)

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

Parameters:

value - Id of the transaction in which the references 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 references should be retrieved. Valid only when used with a workspaceId

Returns:

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

parentChangeId

public final AppElementsResolveReferencesRequest.Builder parentChangeId(String value)

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

Parameters:

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

Returns:

the Builder object.

referenceIds

public final String referenceIds()

Get A list of ids (comma-separated) of the references to resolve, or empty if all.

Returns:

A list of ids (comma-separated) of the references to resolve, or empty if all.

referenceIds

public final AppElementsResolveReferencesRequest.Builder referenceIds(String value)

Set A list of ids (comma-separated) of the references to resolve, or empty if all.

Parameters:

value - A list of ids (comma-separated) of the references to resolve, or empty if all.

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 AppElementsResolveReferencesRequest.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 AppElementsResolveReferencesResponse call(String did,
                                                       WVM wvmType,
                                                       String wvm,
                                                       String eid)
                                                throws OnshapeException

Calls resolveReferences method, Resolve references for an app element

Parameters:

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 AppElementsResolveReferencesResponse call(OnshapeDocument document)
                                                throws OnshapeException

Calls resolveReferences method, Resolve references for an app element

Parameters:

document - Document object from Onshape URL.

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error