Package com.onshape.api.requests

Class MetadataCategorySearchRequest.Builder

java.lang.Object

com.onshape.api.requests.MetadataCategorySearchRequest.Builder

Enclosing class:

MetadataCategorySearchRequest

public static final class MetadataCategorySearchRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
Boolean	activeOnly()	Get If true, only active categories will be returned.
MetadataCategorySearchRequest.Builder	activeOnly(Boolean value)	Set If true, only active categories will be returned.
MetadataCategorySearchResponse	call(String ownerId)	Calls search method, Search metadata categories
String	documentId()	Get ID of the document the categories are associated with.
MetadataCategorySearchRequest.Builder	documentId(String value)	Set ID of the document the categories are associated with.
Boolean	includeOnshape()	Get Flag whether to include or exclude Onshape default categories
MetadataCategorySearchRequest.Builder	includeOnshape(Boolean value)	Set Flag whether to include or exclude Onshape default categories
Number	limit()	Get Number of results to return per page (max is 50)
MetadataCategorySearchRequest.Builder	limit(Number value)	Set Number of results to return per page (max is 50)
Number	objectType()	Get Metadata object type.
MetadataCategorySearchRequest.Builder	objectType(Number value)	Set Metadata object type.
Number	offset()	Get Where to begin search results
MetadataCategorySearchRequest.Builder	offset(Number value)	Set Where to begin search results
Number	ownerType()	Get category owner type, optional that can be: 1:company 2:onshape (default: 1, ONSHAPE categories will be included)
MetadataCategorySearchRequest.Builder	ownerType(Number value)	Set category owner type, optional that can be: 1:company 2:onshape (default: 1, ONSHAPE categories will be included)
String	q()	Get Query string, in null or empty all categories will be returned
MetadataCategorySearchRequest.Builder	q(String value)	Set Query string, in null or empty all categories will be returned

Methods inherited from class java.lang.Object

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

Method Detail

ownerType

public final Number ownerType()

Get category owner type, optional that can be: 1:company 2:onshape (default: 1, ONSHAPE categories will be included)

Returns:

category owner type, optional that can be: 1:company 2:onshape (default: 1, ONSHAPE categories will be included)

ownerType

public final MetadataCategorySearchRequest.Builder ownerType(Number value)

Set category owner type, optional that can be: 1:company 2:onshape (default: 1, ONSHAPE categories will be included)

Parameters:

value - category owner type, optional that can be: 1:company 2:onshape (default: 1, ONSHAPE categories will be included)

Returns:

the Builder object.

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 MetadataCategorySearchRequest.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 BTMetadataObjectType enum ordinal except GLOBAL.

Returns:

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

objectType

public final MetadataCategorySearchRequest.Builder objectType(Number value)

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

Parameters:

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

Returns:

the Builder object.

q

public final String q()

Get Query string, in null or empty all categories will be returned

Returns:

Query string, in null or empty all categories will be returned

q

public final MetadataCategorySearchRequest.Builder q(String value)

Set Query string, in null or empty all categories will be returned

Parameters:

value - Query string, in null or empty all categories will be returned

Returns:

the Builder object.

activeOnly

public final Boolean activeOnly()

Get If true, only active categories will be returned. If false, all categories will be returned.

Returns:

If true, only active categories will be returned. If false, all categories will be returned.

activeOnly

public final MetadataCategorySearchRequest.Builder activeOnly(Boolean value)

Set If true, only active categories will be returned. If false, all categories will be returned.

Parameters:

value - If true, only active categories will be returned. If false, all categories will be returned.

Returns:

the Builder object.

includeOnshape

public final Boolean includeOnshape()

Get Flag whether to include or exclude Onshape default categories

Returns:

Flag whether to include or exclude Onshape default categories

includeOnshape

public final MetadataCategorySearchRequest.Builder includeOnshape(Boolean value)

Set Flag whether to include or exclude Onshape default categories

Parameters:

value - Flag whether to include or exclude Onshape default categories

Returns:

the Builder object.

offset

public final Number offset()

Get Where to begin search results

Returns:

Where to begin search results

offset

public final MetadataCategorySearchRequest.Builder offset(Number value)

Set Where to begin search results

Parameters:

value - Where to begin search results

Returns:

the Builder object.

limit

public final Number limit()

Get Number of results to return per page (max is 50)

Returns:

Number of results to return per page (max is 50)

limit

public final MetadataCategorySearchRequest.Builder limit(Number value)

Set Number of results to return per page (max is 50)

Parameters:

value - Number of results to return per page (max is 50)

Returns:

the Builder object.

call

public final MetadataCategorySearchResponse call(String ownerId)
                                          throws OnshapeException

Calls search method, Search metadata categories

Parameters:

ownerId - category owner id (Default: null)

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error