Package com.onshape.api.requests

Class PartStudiosGetFeatureScriptTableRequest.Builder

java.lang.Object

com.onshape.api.requests.PartStudiosGetFeatureScriptTableRequest.Builder

Enclosing class:

PartStudiosGetFeatureScriptTableRequest

public static final class PartStudiosGetFeatureScriptTableRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
PartStudiosGetFeatureScriptTableResponse	call(OnshapeDocument document, String tableType)	Calls getFeatureScriptTable method, Compute and return a FeatureScript table for a given part studio (and possibly part).
PartStudiosGetFeatureScriptTableResponse	call(String did, WVM wvmType, String wvm, String eid, String tableType)	Calls getFeatureScriptTable method, Compute and return a FeatureScript table for a given part studio (and possibly part).
String	configuration()	Get Configuration string
PartStudiosGetFeatureScriptTableRequest.Builder	configuration(String value)	Set Configuration string
String	linkDocumentId()	Get Id of document that links to the document being accessed.
PartStudiosGetFeatureScriptTableRequest.Builder	linkDocumentId(String value)	Set Id of document that links to the document being accessed.
String	partId()	Get If provided, the function will only return tables associated with that partId
PartStudiosGetFeatureScriptTableRequest.Builder	partId(String value)	Set If provided, the function will only return tables associated with that partId
String	tableNamespace()	Get The namespace of the table definition, empty or omitted if it's a standard table.
PartStudiosGetFeatureScriptTableRequest.Builder	tableNamespace(String value)	Set The namespace of the table definition, empty or omitted if it's a standard table.
String	tableParameters()	Get The parameters to the table function.
PartStudiosGetFeatureScriptTableRequest.Builder	tableParameters(String value)	Set The parameters to the table function.

Methods inherited from class java.lang.Object

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

Method Detail

tableNamespace

public final String tableNamespace()

Get The namespace of the table definition, empty or omitted if it's a standard table. For custom tables it'll usually be in the form d[docId]::v[versionId]::e[elementId]::m[microversionId]

Returns:

The namespace of the table definition, empty or omitted if it's a standard table. For custom tables it'll usually be in the form d[docId]::v[versionId]::e[elementId]::m[microversionId]

tableNamespace

public final PartStudiosGetFeatureScriptTableRequest.Builder tableNamespace(String value)

Set The namespace of the table definition, empty or omitted if it's a standard table. For custom tables it'll usually be in the form d[docId]::v[versionId]::e[elementId]::m[microversionId]

Parameters:

value - The namespace of the table definition, empty or omitted if it's a standard table. For custom tables it'll usually be in the form d[docId]::v[versionId]::e[elementId]::m[microversionId]

Returns:

the Builder object.

tableParameters

public final String tableParameters()

Get The parameters to the table function. They are provided in a similar, but not exactly the same way as configuration parameters. The overall syntax is: param1=value1;param2=value2;...;paramN=valueN For booleans, value must be `true` or `false`. For strings, value must be the string in double quotes. For enums, the value must be of the form EnumName.ENUM_VALUE. Anything else is considered a quantity. //@formatter:on

Returns:

The parameters to the table function. They are provided in a similar, but not exactly the same way as configuration parameters. The overall syntax is: param1=value1;param2=value2;...;paramN=valueN For booleans, value must be `true` or `false`. For strings, value must be the string in double quotes. For enums, the value must be of the form EnumName.ENUM_VALUE. Anything else is considered a quantity. //@formatter:on

tableParameters

public final PartStudiosGetFeatureScriptTableRequest.Builder tableParameters(String value)

Set The parameters to the table function. They are provided in a similar, but not exactly the same way as configuration parameters. The overall syntax is: param1=value1;param2=value2;...;paramN=valueN For booleans, value must be `true` or `false`. For strings, value must be the string in double quotes. For enums, the value must be of the form EnumName.ENUM_VALUE. Anything else is considered a quantity. //@formatter:on

Parameters:

value - The parameters to the table function. They are provided in a similar, but not exactly the same way as configuration parameters. The overall syntax is: param1=value1;param2=value2;...;paramN=valueN For booleans, value must be `true` or `false`. For strings, value must be the string in double quotes. For enums, the value must be of the form EnumName.ENUM_VALUE. Anything else is considered a quantity. //@formatter:on

Returns:

the Builder object.

partId

public final String partId()

Get If provided, the function will only return tables associated with that partId

Returns:

If provided, the function will only return tables associated with that partId

partId

public final PartStudiosGetFeatureScriptTableRequest.Builder partId(String value)

Set If provided, the function will only return tables associated with that partId

Parameters:

value - If provided, the function will only return tables associated with that partId

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

Set Configuration string

Parameters:

value - Configuration string

Returns:

the Builder object.

call

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

Calls getFeatureScriptTable method, Compute and return a FeatureScript table for a given part studio (and possibly part).

Parameters:

did - Document ID

wvmType - Type of Workspace, Version or Microversion

wvm - Workspace (w), Version (v) or Microversion (m) ID

eid - Element ID

tableType - The name of the function that computes the table //@formatter:off (Default: null)

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error

call

public final PartStudiosGetFeatureScriptTableResponse call(OnshapeDocument document,
                                                           String tableType)
                                                    throws OnshapeException

Calls getFeatureScriptTable method, Compute and return a FeatureScript table for a given part studio (and possibly part).

Parameters:

document - Document object from Onshape URL.

tableType - The name of the function that computes the table //@formatter:off (Default: null)

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error