Package com.onshape.api.requests

Class PartStudiosComparePartStudioRequest.Builder

java.lang.Object

com.onshape.api.requests.PartStudiosComparePartStudioRequest.Builder

Enclosing class:

PartStudiosComparePartStudioRequest

public static final class PartStudiosComparePartStudioRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
PartStudiosComparePartStudioResponse	call(OnshapeDocument document)	Calls comparePartStudio method, Compare Part Studio in different versions / workspaces of a Document.
PartStudiosComparePartStudioResponse	call(String did, WVM wvmType, String wvm, String eid)	Calls comparePartStudio method, Compare Part Studio in different versions / workspaces of a Document.
String	linkDocumentId()	Get Id of document that links to the document being accessed.
PartStudiosComparePartStudioRequest.Builder	linkDocumentId(String value)	Set Id of document that links to the document being accessed.
Number	microversionId()	Get Id of a document microversion to compare the Part Studio with
PartStudiosComparePartStudioRequest.Builder	microversionId(Number value)	Set Id of a document microversion to compare the Part Studio with
String	sourceConfiguration()	Get The configuration of the source being compared.
PartStudiosComparePartStudioRequest.Builder	sourceConfiguration(String value)	Set The configuration of the source being compared.
String	targetConfiguration()	Get The configuration of the target being compared.
PartStudiosComparePartStudioRequest.Builder	targetConfiguration(String value)	Set The configuration of the target being compared.
String	versionId()	Get Id of a Version to compare the Part Studio with
PartStudiosComparePartStudioRequest.Builder	versionId(String value)	Set Id of a Version to compare the Part Studio with
String	workspaceId()	Get Id of the Workspace to compare the Part Studio with
PartStudiosComparePartStudioRequest.Builder	workspaceId(String value)	Set Id of the Workspace to compare the Part Studio with

Methods inherited from class java.lang.Object

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

Method Detail

workspaceId

public final String workspaceId()

Get Id of the Workspace to compare the Part Studio with

Returns:

Id of the Workspace to compare the Part Studio with

workspaceId

public final PartStudiosComparePartStudioRequest.Builder workspaceId(String value)

Set Id of the Workspace to compare the Part Studio with

Parameters:

value - Id of the Workspace to compare the Part Studio with

Returns:

the Builder object.

versionId

public final String versionId()

Get Id of a Version to compare the Part Studio with

Returns:

Id of a Version to compare the Part Studio with

versionId

public final PartStudiosComparePartStudioRequest.Builder versionId(String value)

Set Id of a Version to compare the Part Studio with

Parameters:

value - Id of a Version to compare the Part Studio with

Returns:

the Builder object.

microversionId

public final Number microversionId()

Get Id of a document microversion to compare the Part Studio with

Returns:

Id of a document microversion to compare the Part Studio with

microversionId

public final PartStudiosComparePartStudioRequest.Builder microversionId(Number value)

Set Id of a document microversion to compare the Part Studio with

Parameters:

value - Id of a document microversion to compare the Part Studio with

Returns:

the Builder object.

sourceConfiguration

public final String sourceConfiguration()

Get The configuration of the source being compared.

Returns:

The configuration of the source being compared.

sourceConfiguration

public final PartStudiosComparePartStudioRequest.Builder sourceConfiguration(String value)

Set The configuration of the source being compared.

Parameters:

value - The configuration of the source being compared.

Returns:

the Builder object.

targetConfiguration

public final String targetConfiguration()

Get The configuration of the target being compared.

Returns:

The configuration of the target being compared.

targetConfiguration

public final PartStudiosComparePartStudioRequest.Builder targetConfiguration(String value)

Set The configuration of the target being compared.

Parameters:

value - The configuration of the target being compared.

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

Calls comparePartStudio method, Compare Part Studio in different versions / workspaces of a Document. Comparison can be done between any combinations of source Workspace | Version | Microversion (specified in URL) and target Workspace | Version | Microversion (specified as a query parameter). One of versionId, workspaceId, or microversionId query parameters needs to be specified to identify target microversion of the comparison. The result of the comparison is indicated by the following values: of NONE - entity exists in both source and target states and there's no change in its state | MODIFIED - entity exists in both source and target states and there's some change in its state | ADDED - entity exists in target only | DELETED - entity exists in source only.

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

Calls comparePartStudio method, Compare Part Studio in different versions / workspaces of a Document. Comparison can be done between any combinations of source Workspace | Version | Microversion (specified in URL) and target Workspace | Version | Microversion (specified as a query parameter). One of versionId, workspaceId, or microversionId query parameters needs to be specified to identify target microversion of the comparison. The result of the comparison is indicated by the following values: of NONE - entity exists in both source and target states and there's no change in its state | MODIFIED - entity exists in both source and target states and there's some change in its state | ADDED - entity exists in target only | DELETED - entity exists in source only.

Parameters:

document - Document object from Onshape URL.

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error