Package com.onshape.api.responses

Class MetadataCategorySearchResponseItems

java.lang.Object

com.onshape.api.types.AbstractResponseObject

com.onshape.api.responses.MetadataCategorySearchResponseItems

public final class MetadataCategorySearchResponseItems
extends AbstractResponseObject

Object used in calls to search API endpoint. © 2018-Present Onshape Inc.

Field Summary

Fields

Modifier and Type	Field	Description
String	description	Category description
String	id	Category id
MetadataCategorySearchResponseItemsMemberCategories[]	memberCategories	List of member category info objects
String[]	memberCategoryIds	List of ids of the categories this category is member of
String	name	Category name
Number[]	objectTypes	List of metadata object types this category is applicable for picking
String	ownerId	CompanyId that owns the category
Number	ownerType	Category owner type, which will be: 1:company, 2: onshape
Number	publishState	Category publish state, which can be: 0: PENDING, 1: ACTIVE, 2: INACTIVE

Constructor Summary

Constructors

Constructor	Description
MetadataCategorySearchResponseItems()

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Get Category description
String	getId()	Get Category id
MetadataCategorySearchResponseItemsMemberCategories[]	getMemberCategories()	Get List of member category info objects
String[]	getMemberCategoryIds()	Get List of ids of the categories this category is member of
String	getName()	Get Category name
Number[]	getObjectTypes()	Get List of metadata object types this category is applicable for picking
String	getOwnerId()	Get CompanyId that owns the category
Number	getOwnerType()	Get Category owner type, which will be: 1:company, 2: onshape
Number	getPublishState()	Get Category publish state, which can be: 0: PENDING, 1: ACTIVE, 2: INACTIVE
String	toString()

Methods inherited from class com.onshape.api.types.AbstractResponseObject

getOtherProperties

Methods inherited from class java.lang.Object

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

Field Detail

id

public String id

Category id

name

public String name

Category name

description

public String description

Category description

ownerId

public String ownerId

CompanyId that owns the category

ownerType

public Number ownerType

Category owner type, which will be: 1:company, 2: onshape

publishState

public Number publishState

Category publish state, which can be: 0: PENDING, 1: ACTIVE, 2: INACTIVE

objectTypes

public Number[] objectTypes

List of metadata object types this category is applicable for picking

memberCategoryIds

public String[] memberCategoryIds

List of ids of the categories this category is member of

memberCategories

public MetadataCategorySearchResponseItemsMemberCategories[] memberCategories

List of member category info objects

Constructor Detail

MetadataCategorySearchResponseItems

public MetadataCategorySearchResponseItems()

Method Detail

getId

public final String getId()

Get Category id

Returns:

Category id

getName

public final String getName()

Get Category name

Returns:

Category name

getDescription

public final String getDescription()

Get Category description

Returns:

Category description

getOwnerId

public final String getOwnerId()

Get CompanyId that owns the category

Returns:

CompanyId that owns the category

getOwnerType

public final Number getOwnerType()

Get Category owner type, which will be: 1:company, 2: onshape

Returns:

Category owner type, which will be: 1:company, 2: onshape

getPublishState

public final Number getPublishState()

Get Category publish state, which can be: 0: PENDING, 1: ACTIVE, 2: INACTIVE

Returns:

Category publish state, which can be: 0: PENDING, 1: ACTIVE, 2: INACTIVE

getObjectTypes

public final Number[] getObjectTypes()

Get List of metadata object types this category is applicable for picking

Returns:

List of metadata object types this category is applicable for picking

getMemberCategoryIds

public final String[] getMemberCategoryIds()

Get List of ids of the categories this category is member of

Returns:

List of ids of the categories this category is member of

getMemberCategories

public final MetadataCategorySearchResponseItemsMemberCategories[] getMemberCategories()

Get List of member category info objects

Returns:

List of member category info objects

toString

public String toString()

Overrides:

toString in class Object