Package com.onshape.api.requests

Class ElementsDecodeConfigurationStringRequest.Builder

java.lang.Object

com.onshape.api.requests.ElementsDecodeConfigurationStringRequest.Builder

Enclosing class:

ElementsDecodeConfigurationStringRequest

public static final class ElementsDecodeConfigurationStringRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
ElementsDecodeConfigurationStringResponse	call(OnshapeDocument document, String cid)	Calls decodeConfigurationString method, Converts a configuration string or configuration id into parameter map form.
ElementsDecodeConfigurationStringResponse	call(String cid, String did, WVM wvmType, String wvm, String eid)	Calls decodeConfigurationString method, Converts a configuration string or configuration id into parameter map form.
Boolean	configurationIsId()	Get If true, the cid parameter should be interpreted as a configurationId rather than an encoded configuration, in which case the wvmid must be a version or microversion and the configurationId must be obtained from that version or microversion.
ElementsDecodeConfigurationStringRequest.Builder	configurationIsId(Boolean value)	Set If true, the cid parameter should be interpreted as a configurationId rather than an encoded configuration, in which case the wvmid must be a version or microversion and the configurationId must be obtained from that version or microversion.
Boolean	includeDisplay()	Get If true, additional data is returned for user-viewable information
ElementsDecodeConfigurationStringRequest.Builder	includeDisplay(Boolean value)	Set If true, additional data is returned for user-viewable information
String	linkDocumentId()	Get Id of document that links to the document being accessed.
ElementsDecodeConfigurationStringRequest.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

includeDisplay

public final Boolean includeDisplay()

Get If true, additional data is returned for user-viewable information

Returns:

If true, additional data is returned for user-viewable information

includeDisplay

public final ElementsDecodeConfigurationStringRequest.Builder includeDisplay(Boolean value)

Set If true, additional data is returned for user-viewable information

Parameters:

value - If true, additional data is returned for user-viewable information

Returns:

the Builder object.

configurationIsId

public final Boolean configurationIsId()

Get If true, the cid parameter should be interpreted as a configurationId rather than an encoded configuration, in which case the wvmid must be a version or microversion and the configurationId must be obtained from that version or microversion.

Returns:

If true, the cid parameter should be interpreted as a configurationId rather than an encoded configuration, in which case the wvmid must be a version or microversion and the configurationId must be obtained from that version or microversion.

configurationIsId

public final ElementsDecodeConfigurationStringRequest.Builder configurationIsId(Boolean value)

Set If true, the cid parameter should be interpreted as a configurationId rather than an encoded configuration, in which case the wvmid must be a version or microversion and the configurationId must be obtained from that version or microversion.

Parameters:

value - If true, the cid parameter should be interpreted as a configurationId rather than an encoded configuration, in which case the wvmid must be a version or microversion and the configurationId must be obtained from that version or microversion.

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

Calls decodeConfigurationString method, Converts a configuration string or configuration id into parameter map form.

Parameters:

cid - configuration string or configuration id to decode (must be url-encoded).

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 ElementsDecodeConfigurationStringResponse call(OnshapeDocument document,
                                                            String cid)
                                                     throws OnshapeException

Calls decodeConfigurationString method, Converts a configuration string or configuration id into parameter map form.

Parameters:

document - Document object from Onshape URL.

cid - configuration string or configuration id to decode (must be url-encoded).

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error