Package com.onshape.api.requests

Class AppElementsCreateElementRequest.Builder

java.lang.Object

com.onshape.api.requests.AppElementsCreateElementRequest.Builder

Enclosing class:

AppElementsCreateElementRequest

public static final class AppElementsCreateElementRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
AppElementsCreateElementResponse	call(OnshapeDocument document)	Calls createElement method, Create an app element
AppElementsCreateElementResponse	call(String did, String wid)	Calls createElement method, Create an app element
String	description()	Get Description of the change being made, for history tracking
AppElementsCreateElementRequest.Builder	description(String value)	Set Description of the change being made, for history tracking
String	formatId()	Get The format id for the application element
AppElementsCreateElementRequest.Builder	formatId(String value)	Set The format id for the application element
Map	jsonTree()	Get The initial json tree in the element.
AppElementsCreateElementRequest.Builder	jsonTree(Map value)	Set The initial json tree in the element.
AppElementsCreateElementRequestLocation	location()	Get Location at which element should be inserted.
AppElementsCreateElementRequest.Builder	location(AppElementsCreateElementRequestLocation value)	Set Location at which element should be inserted.
String	name()	Get Requested app-element name
AppElementsCreateElementRequest.Builder	name(String value)	Set Requested app-element name
AppElementsCreateElementRequestSubelements[]	subelements()	Get Initial list of sub-element contents
AppElementsCreateElementRequest.Builder	subelements(AppElementsCreateElementRequestSubelements[] value)	Set Initial list of sub-element contents

Methods inherited from class java.lang.Object

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

Method Detail

formatId

public final String formatId()

Get The format id for the application element

Returns:

The format id for the application element

formatId

public final AppElementsCreateElementRequest.Builder formatId(String value)

Set The format id for the application element

Parameters:

value - The format id for the application element

Returns:

the Builder object.

name

public final String name()

Get Requested app-element name

Returns:

Requested app-element name

name

public final AppElementsCreateElementRequest.Builder name(String value)

Set Requested app-element name

Parameters:

value - Requested app-element name

Returns:

the Builder object.

description

public final String description()

Get Description of the change being made, for history tracking

Returns:

Description of the change being made, for history tracking

description

public final AppElementsCreateElementRequest.Builder description(String value)

Set Description of the change being made, for history tracking

Parameters:

value - Description of the change being made, for history tracking

Returns:

the Builder object.

subelements

public final AppElementsCreateElementRequestSubelements[] subelements()

Get Initial list of sub-element contents

Returns:

Initial list of sub-element contents

subelements

public final AppElementsCreateElementRequest.Builder subelements(AppElementsCreateElementRequestSubelements[] value)

Set Initial list of sub-element contents

Parameters:

value - Initial list of sub-element contents

Returns:

the Builder object.

jsonTree

public final Map jsonTree()

Get The initial json tree in the element.

Returns:

The initial json tree in the element.

jsonTree

public final AppElementsCreateElementRequest.Builder jsonTree(Map value)

Set The initial json tree in the element.

Parameters:

value - The initial json tree in the element.

Returns:

the Builder object.

location

public final AppElementsCreateElementRequestLocation location()

Get Location at which element should be inserted.

Returns:

Location at which element should be inserted.

location

public final AppElementsCreateElementRequest.Builder location(AppElementsCreateElementRequestLocation value)

Set Location at which element should be inserted.

Parameters:

value - Location at which element should be inserted.

Returns:

the Builder object.

call

public final AppElementsCreateElementResponse call(String did,
                                                   String wid)
                                            throws OnshapeException

Calls createElement method, Create an app element

Parameters:

did - Document ID

wid - Workspace ID

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error

call

public final AppElementsCreateElementResponse call(OnshapeDocument document)
                                            throws OnshapeException

Calls createElement method, Create an app element

Parameters:

document - Document object from Onshape URL.

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error