Package com.onshape.api.requests

Class PartStudiosGetBodyDetailsRequest.Builder

java.lang.Object

com.onshape.api.requests.PartStudiosGetBodyDetailsRequest.Builder

Enclosing class:

PartStudiosGetBodyDetailsRequest

public static final class PartStudiosGetBodyDetailsRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
PartStudiosGetBodyDetailsResponse	call(OnshapeDocument document)	Calls getBodyDetails method, Get the body details of a Part Studio.
PartStudiosGetBodyDetailsResponse	call(String did, WVM wvmType, String wvm, String eid)	Calls getBodyDetails method, Get the body details of a Part Studio.
String	configuration()	Get Configuration string
PartStudiosGetBodyDetailsRequest.Builder	configuration(String value)	Set Configuration string
String	linkDocumentId()	Get Id of document that links to the document being accessed.
PartStudiosGetBodyDetailsRequest.Builder	linkDocumentId(String value)	Set Id of document that links to the document being accessed.
Number	rollbackBarIndex()	Get Index specifying the location of the rollback bar when the call is evaluated.
PartStudiosGetBodyDetailsRequest.Builder	rollbackBarIndex(Number value)	Set Index specifying the location of the rollback bar when the call is evaluated.

Methods inherited from class java.lang.Object

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

Method Detail

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

configuration

public final String configuration()

Get Configuration string

Returns:

Configuration string

configuration

public final PartStudiosGetBodyDetailsRequest.Builder configuration(String value)

Set Configuration string

Parameters:

value - Configuration string

Returns:

the Builder object.

rollbackBarIndex

public final Number rollbackBarIndex()

Get Index specifying the location of the rollback bar when the call is evaluated. A -1 indicates that it should be at the end of the featurelist.

Returns:

Index specifying the location of the rollback bar when the call is evaluated. A -1 indicates that it should be at the end of the featurelist.

rollbackBarIndex

public final PartStudiosGetBodyDetailsRequest.Builder rollbackBarIndex(Number value)

Set Index specifying the location of the rollback bar when the call is evaluated. A -1 indicates that it should be at the end of the featurelist.

Parameters:

value - Index specifying the location of the rollback bar when the call is evaluated. A -1 indicates that it should be at the end of the featurelist.

Returns:

the Builder object.

call

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

Calls getBodyDetails method, Get the body details of a Part Studio. All coordinates are in meters.

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

Calls getBodyDetails method, Get the body details of a Part Studio. All coordinates are in meters.

Parameters:

document - Document object from Onshape URL.

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error