Package com.onshape.api.requests

Class PartsGetBoundingBoxesRequest.Builder

java.lang.Object

com.onshape.api.requests.PartsGetBoundingBoxesRequest.Builder

Enclosing class:

PartsGetBoundingBoxesRequest

public static final class PartsGetBoundingBoxesRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
PartsGetBoundingBoxesResponse	call(OnshapeDocument document, String partid)	Calls getBoundingBoxes method, Get the bounding box of a part.
PartsGetBoundingBoxesResponse	call(String did, WVM wvmType, String wvm, String eid, String partid)	Calls getBoundingBoxes method, Get the bounding box of a part.
String	configuration()	Get Configuration string
PartsGetBoundingBoxesRequest.Builder	configuration(String value)	Set Configuration string
Boolean	includeHidden()	Get Whether or not to include bounding boxes for hidden parts
PartsGetBoundingBoxesRequest.Builder	includeHidden(Boolean value)	Set Whether or not to include bounding boxes for hidden parts
String	linkDocumentId()	Get Id of document that links to the document being accessed.
PartsGetBoundingBoxesRequest.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 PartsGetBoundingBoxesRequest.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.

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

Set Configuration string

Parameters:

value - Configuration string

Returns:

the Builder object.

call

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

Calls getBoundingBoxes method, Get the bounding box of a part. 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

partid - Part ID (must be URL encoded)

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error

call

public final PartsGetBoundingBoxesResponse call(OnshapeDocument document,
                                                String partid)
                                         throws OnshapeException

Calls getBoundingBoxes method, Get the bounding box of a part. All coordinates are in meters.

Parameters:

document - Document object from Onshape URL.

partid - Part ID (must be URL encoded)

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error