Package com.onshape.api.requests

Class RevisionsCreateRuleRequest.Builder

java.lang.Object

com.onshape.api.requests.RevisionsCreateRuleRequest.Builder

Enclosing class:

RevisionsCreateRuleRequest

public static final class RevisionsCreateRuleRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
RevisionsCreateRuleResponse	call()	Calls createRule method, Create a new revision rule for a company
String	companyId()	Get ID of the company to which the revision rule belongs
RevisionsCreateRuleRequest.Builder	companyId(String value)	Set ID of the company to which the revision rule belongs
String	description()	Get Description of revision rule
RevisionsCreateRuleRequest.Builder	description(String value)	Set Description of revision rule
String	name()	Get Name of revision rule
RevisionsCreateRuleRequest.Builder	name(String value)	Set Name of revision rule
String[]	revisionList()	Get List of revisions associated with the rule.
RevisionsCreateRuleRequest.Builder	revisionList(String[] value)	Set List of revisions associated with the rule.
Number	ruleType()	Get Method of determining next revisions.
RevisionsCreateRuleRequest.Builder	ruleType(Number value)	Set Method of determining next revisions.

Methods inherited from class java.lang.Object

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

Method Detail

name

public final String name()

Get Name of revision rule

Returns:

Name of revision rule

name

public final RevisionsCreateRuleRequest.Builder name(String value)

Set Name of revision rule

Parameters:

value - Name of revision rule

Returns:

the Builder object.

description

public final String description()

Get Description of revision rule

Returns:

Description of revision rule

description

public final RevisionsCreateRuleRequest.Builder description(String value)

Set Description of revision rule

Parameters:

value - Description of revision rule

Returns:

the Builder object.

companyId

public final String companyId()

Get ID of the company to which the revision rule belongs

Returns:

ID of the company to which the revision rule belongs

companyId

public final RevisionsCreateRuleRequest.Builder companyId(String value)

Set ID of the company to which the revision rule belongs

Parameters:

value - ID of the company to which the revision rule belongs

Returns:

the Builder object.

ruleType

public final Number ruleType()

Get Method of determining next revisions. 0=Javascript, 1=List. Only List is currently supported for custom revision rules.

Returns:

Method of determining next revisions. 0=Javascript, 1=List. Only List is currently supported for custom revision rules.

ruleType

public final RevisionsCreateRuleRequest.Builder ruleType(Number value)

Set Method of determining next revisions. 0=Javascript, 1=List. Only List is currently supported for custom revision rules.

Parameters:

value - Method of determining next revisions. 0=Javascript, 1=List. Only List is currently supported for custom revision rules.

Returns:

the Builder object.

revisionList

public final String[] revisionList()

Get List of revisions associated with the rule. Must contain at least 50 unique revisions.

Returns:

List of revisions associated with the rule. Must contain at least 50 unique revisions.

revisionList

public final RevisionsCreateRuleRequest.Builder revisionList(String[] value)

Set List of revisions associated with the rule. Must contain at least 50 unique revisions.

Parameters:

value - List of revisions associated with the rule. Must contain at least 50 unique revisions.

Returns:

the Builder object.

call

public final RevisionsCreateRuleResponse call()
                                       throws OnshapeException

Calls createRule method, Create a new revision rule for a company

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error