Package com.onshape.api.requests

Class PartStudiosGetBoundingBoxesRequest.Builder

java.lang.Object

com.onshape.api.requests.PartStudiosGetBoundingBoxesRequest.Builder

Enclosing class:

PartStudiosGetBoundingBoxesRequest

public static final class PartStudiosGetBoundingBoxesRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
PartStudiosGetBoundingBoxesResponse	call(OnshapeDocument document)	Calls getBoundingBoxes method, Get the bounding box of a Part Studio, or an empty object if the Part Studio is empty.
PartStudiosGetBoundingBoxesResponse	call(String did, WVM wvmType, String wvm, String eid)	Calls getBoundingBoxes method, Get the bounding box of a Part Studio, or an empty object if the Part Studio is empty.
String	configuration()	Get Configuration string
PartStudiosGetBoundingBoxesRequest.Builder	configuration(String value)	Set Configuration string
Boolean	includeHidden()	Get Whether or not to include bounding boxes for hidden parts
PartStudiosGetBoundingBoxesRequest.Builder	includeHidden(Boolean value)	Set Whether or not to include bounding boxes for hidden parts
Boolean	includeWireBodies()	Get Whether to include wire bodies in the bounding box calculation
PartStudiosGetBoundingBoxesRequest.Builder	includeWireBodies(Boolean value)	Set Whether to include wire bodies in the bounding box calculation
String	linkDocumentId()	Get Id of document that links to the document being accessed.
PartStudiosGetBoundingBoxesRequest.Builder	linkDocumentId(String value)	Set Id of document that links to the document being accessed.

Methods inherited from class java.lang.Object

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

Method Detail

includeHidden

public final Boolean includeHidden()

Get Whether or not to include bounding boxes for hidden parts

Returns:

Whether or not to include bounding boxes for hidden parts

includeHidden

public final PartStudiosGetBoundingBoxesRequest.Builder includeHidden(Boolean value)

Set Whether or not to include bounding boxes for hidden parts

Parameters:

value - Whether or not to include bounding boxes for hidden parts

Returns:

the Builder object.

includeWireBodies

public final Boolean includeWireBodies()

Get Whether to include wire bodies in the bounding box calculation

Returns:

Whether to include wire bodies in the bounding box calculation

includeWireBodies

public final PartStudiosGetBoundingBoxesRequest.Builder includeWireBodies(Boolean value)

Set Whether to include wire bodies in the bounding box calculation

Parameters:

value - Whether to include wire bodies in the bounding box calculation

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 PartStudiosGetBoundingBoxesRequest.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 PartStudiosGetBoundingBoxesRequest.Builder configuration(String value)

Set Configuration string

Parameters:

value - Configuration string

Returns:

the Builder object.

call

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

Calls getBoundingBoxes method, Get the bounding box of a Part Studio, or an empty object if the Part Studio is empty. All coordinates are in meters. Sketches are not used in computing the result.

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

Calls getBoundingBoxes method, Get the bounding box of a Part Studio, or an empty object if the Part Studio is empty. All coordinates are in meters. Sketches are not used in computing the result.

Parameters:

document - Document object from Onshape URL.

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error