Package com.onshape.api.requests

Class PartStudiosGetMassPropertiesRequest.Builder

java.lang.Object

com.onshape.api.requests.PartStudiosGetMassPropertiesRequest.Builder

Enclosing class:

PartStudiosGetMassPropertiesRequest

public static final class PartStudiosGetMassPropertiesRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
PartStudiosGetMassPropertiesResponse	call(OnshapeDocument document)	Calls getMassProperties method, Get the mass properties of a part studio or parts; parts must have density in order to have mass.
PartStudiosGetMassPropertiesResponse	call(String did, WVM wvmType, String wvm, String eid)	Calls getMassProperties method, Get the mass properties of a part studio or parts; parts must have density in order to have mass.
String	configuration()	Get Configuration string
PartStudiosGetMassPropertiesRequest.Builder	configuration(String value)	Set Configuration string
String	linkDocumentId()	Get Id of document that links to the document being accessed.
PartStudiosGetMassPropertiesRequest.Builder	linkDocumentId(String value)	Set Id of document that links to the document being accessed.
Boolean	massAsGroup()	Get If true, specified parts will be evaluated as a single object instead of individually
PartStudiosGetMassPropertiesRequest.Builder	massAsGroup(Boolean value)	Set If true, specified parts will be evaluated as a single object instead of individually
String	partId()	Get IDs of the parts for which to retrieve mass properties (repeat query param to add more than one, i.e.
PartStudiosGetMassPropertiesRequest.Builder	partId(String value)	Set IDs of the parts for which to retrieve mass properties (repeat query param to add more than one, i.e.

Methods inherited from class java.lang.Object

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

Method Detail

partId

public final String partId()

Get IDs of the parts for which to retrieve mass properties (repeat query param to add more than one, i.e. partId=JHK&partId=JHD)

Returns:

IDs of the parts for which to retrieve mass properties (repeat query param to add more than one, i.e. partId=JHK&partId=JHD)

partId

public final PartStudiosGetMassPropertiesRequest.Builder partId(String value)

Set IDs of the parts for which to retrieve mass properties (repeat query param to add more than one, i.e. partId=JHK&partId=JHD)

Parameters:

value - IDs of the parts for which to retrieve mass properties (repeat query param to add more than one, i.e. partId=JHK&partId=JHD)

Returns:

the Builder object.

massAsGroup

public final Boolean massAsGroup()

Get If true, specified parts will be evaluated as a single object instead of individually

Returns:

If true, specified parts will be evaluated as a single object instead of individually

massAsGroup

public final PartStudiosGetMassPropertiesRequest.Builder massAsGroup(Boolean value)

Set If true, specified parts will be evaluated as a single object instead of individually

Parameters:

value - If true, specified parts will be evaluated as a single object instead of individually

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

Set Configuration string

Parameters:

value - Configuration string

Returns:

the Builder object.

call

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

Calls getMassProperties method, Get the mass properties of a part studio or parts; parts must have density in order to have mass. For properties that come in sets of three, the first set is the calculated value, and the second and third are minimum and maximum possible values considering tolerance.

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

Calls getMassProperties method, Get the mass properties of a part studio or parts; parts must have density in order to have mass. For properties that come in sets of three, the first set is the calculated value, and the second and third are minimum and maximum possible values considering tolerance.

Parameters:

document - Document object from Onshape URL.

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error