Package com.onshape.api.requests

Class MetadataCategoryGetMetadataCategoryPropertiesRequest.Builder

java.lang.Object

com.onshape.api.requests.MetadataCategoryGetMetadataCategoryPropertiesRequest.Builder

Enclosing class:

MetadataCategoryGetMetadataCategoryPropertiesRequest

public static final class MetadataCategoryGetMetadataCategoryPropertiesRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
MetadataCategoryGetMetadataCategoryPropertiesResponse	call(String ownerId, Number ownerType, String[] categoryIds)	Calls getMetadataCategoryProperties method, Get metadata category properties
String	documentId()	Get ID of the document the categories are associated with.
MetadataCategoryGetMetadataCategoryPropertiesRequest.Builder	documentId(String value)	Set ID of the document the categories are associated with.
Boolean	includeComputedProperties()	Get If true, computed properties will be included in results
MetadataCategoryGetMetadataCategoryPropertiesRequest.Builder	includeComputedProperties(Boolean value)	Set If true, computed properties will be included in results
Boolean	includeObjectTypeDefaults()	Get Default properties for the <code>objectType</code> specified should be included in the response
MetadataCategoryGetMetadataCategoryPropertiesRequest.Builder	includeObjectTypeDefaults(Boolean value)	Set Default properties for the <code>objectType</code> specified should be included in the response
Boolean	includePartPropertiesTableOnlyProperties()	Get If true, properties found in the part properties table wil be included in the results
MetadataCategoryGetMetadataCategoryPropertiesRequest.Builder	includePartPropertiesTableOnlyProperties(Boolean value)	Set If true, properties found in the part properties table wil be included in the results
Number	objectType()	Get Metadata object type.
MetadataCategoryGetMetadataCategoryPropertiesRequest.Builder	objectType(Number value)	Set Metadata object type.
Boolean	onlyActive()	Get If true, only active properties will be returned
MetadataCategoryGetMetadataCategoryPropertiesRequest.Builder	onlyActive(Boolean value)	Set If true, only active properties will be returned
Boolean	strict()	Get If true: only those properties reachable by the specified category ids will be included.
MetadataCategoryGetMetadataCategoryPropertiesRequest.Builder	strict(Boolean value)	Set If true: only those properties reachable by the specified category ids will be included.

Methods inherited from class java.lang.Object

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

Method Detail

documentId

public final String documentId()

Get ID of the document the categories are associated with.

Returns:

ID of the document the categories are associated with.

documentId

public final MetadataCategoryGetMetadataCategoryPropertiesRequest.Builder documentId(String value)

Set ID of the document the categories are associated with.

Parameters:

value - ID of the document the categories are associated with.

Returns:

the Builder object.

objectType

public final Number objectType()

Get Metadata object type. Optional but if specified it must be any BTMetadataObjectType enum ordinal except GLOBAL.

Returns:

Metadata object type. Optional but if specified it must be any BTMetadataObjectType enum ordinal except GLOBAL.

objectType

public final MetadataCategoryGetMetadataCategoryPropertiesRequest.Builder objectType(Number value)

Set Metadata object type. Optional but if specified it must be any BTMetadataObjectType enum ordinal except GLOBAL.

Parameters:

value - Metadata object type. Optional but if specified it must be any BTMetadataObjectType enum ordinal except GLOBAL.

Returns:

the Builder object.

strict

public final Boolean strict()

Get If true: only those properties reachable by the specified category ids will be included. Otherwise: category properties, system properties, global defaults and, if <code>includeObjectTypeDefaults</code> is true, default properties for the objectType will be included

Returns:

If true: only those properties reachable by the specified category ids will be included. Otherwise: category properties, system properties, global defaults and, if <code>includeObjectTypeDefaults</code> is true, default properties for the objectType will be included

strict

public final MetadataCategoryGetMetadataCategoryPropertiesRequest.Builder strict(Boolean value)

Set If true: only those properties reachable by the specified category ids will be included. Otherwise: category properties, system properties, global defaults and, if <code>includeObjectTypeDefaults</code> is true, default properties for the objectType will be included

Parameters:

value - If true: only those properties reachable by the specified category ids will be included. Otherwise: category properties, system properties, global defaults and, if <code>includeObjectTypeDefaults</code> is true, default properties for the objectType will be included

Returns:

the Builder object.

includeObjectTypeDefaults

public final Boolean includeObjectTypeDefaults()

Get Default properties for the <code>objectType</code> specified should be included in the response

Returns:

Default properties for the <code>objectType</code> specified should be included in the response

includeObjectTypeDefaults

public final MetadataCategoryGetMetadataCategoryPropertiesRequest.Builder includeObjectTypeDefaults(Boolean value)

Set Default properties for the <code>objectType</code> specified should be included in the response

Parameters:

value - Default properties for the <code>objectType</code> specified should be included in the response

Returns:

the Builder object.

includeComputedProperties

public final Boolean includeComputedProperties()

Get If true, computed properties will be included in results

Returns:

If true, computed properties will be included in results

includeComputedProperties

public final MetadataCategoryGetMetadataCategoryPropertiesRequest.Builder includeComputedProperties(Boolean value)

Set If true, computed properties will be included in results

Parameters:

value - If true, computed properties will be included in results

Returns:

the Builder object.

includePartPropertiesTableOnlyProperties

public final Boolean includePartPropertiesTableOnlyProperties()

Get If true, properties found in the part properties table wil be included in the results

Returns:

If true, properties found in the part properties table wil be included in the results

includePartPropertiesTableOnlyProperties

public final MetadataCategoryGetMetadataCategoryPropertiesRequest.Builder includePartPropertiesTableOnlyProperties(Boolean value)

Set If true, properties found in the part properties table wil be included in the results

Parameters:

value - If true, properties found in the part properties table wil be included in the results

Returns:

the Builder object.

onlyActive

public final Boolean onlyActive()

Get If true, only active properties will be returned

Returns:

If true, only active properties will be returned

onlyActive

public final MetadataCategoryGetMetadataCategoryPropertiesRequest.Builder onlyActive(Boolean value)

Set If true, only active properties will be returned

Parameters:

value - If true, only active properties will be returned

Returns:

the Builder object.

call

public final MetadataCategoryGetMetadataCategoryPropertiesResponse call(String ownerId,
                                                                        Number ownerType,
                                                                        String[] categoryIds)
                                                                 throws OnshapeException

Calls getMetadataCategoryProperties method, Get metadata category properties

Parameters:

ownerId - Owner ID. Must be specified. (Default: null)

ownerType - Schema owner type must be 1 company which is the default. (Default: null)

categoryIds - Metadata category IDs, must be specified if <code>strict</code> is true (Default: null)

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error