Package com.onshape.api.requests

Class PartStudiosGetBoundingBoxesForSketchRequest.Builder

java.lang.Object

com.onshape.api.requests.PartStudiosGetBoundingBoxesForSketchRequest.Builder

Enclosing class:

PartStudiosGetBoundingBoxesForSketchRequest

public static final class PartStudiosGetBoundingBoxesForSketchRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
PartStudiosGetBoundingBoxesForSketchResponse	call(OnshapeDocument document, String sid)	Calls getBoundingBoxesForSketch method, Get the bounding box of a sketch.
PartStudiosGetBoundingBoxesForSketchResponse	call(String did, WVM wvmType, String wvm, String eid, String sid)	Calls getBoundingBoxesForSketch method, Get the bounding box of a sketch.
String	configuration()	Get Configuration string
PartStudiosGetBoundingBoxesForSketchRequest.Builder	configuration(String value)	Set Configuration string
String	linkDocumentId()	Get Id of document that links to the document being accessed.
PartStudiosGetBoundingBoxesForSketchRequest.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

configuration

public final String configuration()

Get Configuration string

Returns:

Configuration string

configuration

public final PartStudiosGetBoundingBoxesForSketchRequest.Builder configuration(String value)

Set Configuration string

Parameters:

value - Configuration string

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

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

sid - Sketch feature ID

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error

call

public final PartStudiosGetBoundingBoxesForSketchResponse call(OnshapeDocument document,
                                                               String sid)
                                                        throws OnshapeException

Calls getBoundingBoxesForSketch method, Get the bounding box of a sketch. All coordinates are in meters.

Parameters:

document - Document object from Onshape URL.

sid - Sketch feature ID

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error