com.smartsheet.api.models

Class ContainerDestination.AddContainerDestinationBuilder

java.lang.Object

com.smartsheet.api.models.ContainerDestination.AddContainerDestinationBuilder

Enclosing class:

ContainerDestination

public static class ContainerDestination.AddContainerDestinationBuilder
extends Object

A convenience class to generate a comment with the appropriate fields for adding it to a sheet.

Constructor Summary

Constructors

Constructor and Description
AddContainerDestinationBuilder()

Method Summary

Modifier and Type	Method and Description
ContainerDestination	build() Builds the comment.
Long	getDestinationId() Gets the destination id when copying or moving a Sheet or a Folder.
DestinationType	getDestinationType() Gets the destination type when copying or moving a Sheet or a Folder.
String	getNewName() Gets the destination name when copying or moving a Sheet or a Folder.
ContainerDestination.AddContainerDestinationBuilder	setDestinationId(Long destinationId) Sets the id for the folder
ContainerDestination.AddContainerDestinationBuilder	setDestinationType(DestinationType destinationType) Sets the type for the folder
ContainerDestination.AddContainerDestinationBuilder	setNewName(String newName) Sets the name for the folder

Methods inherited from class java.lang.Object

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

Constructor Detail

AddContainerDestinationBuilder

public AddContainerDestinationBuilder()

Method Detail

getDestinationType

public DestinationType getDestinationType()

Gets the destination type when copying or moving a Sheet or a Folder.

Returns:

the destination type

setDestinationType

public ContainerDestination.AddContainerDestinationBuilder setDestinationType(DestinationType destinationType)

Sets the type for the folder

Parameters:

destinationType - the destination type

Returns:

the builder

getDestinationId

public Long getDestinationId()

Gets the destination id when copying or moving a Sheet or a Folder.

Returns:

the destination id

setDestinationId

public ContainerDestination.AddContainerDestinationBuilder setDestinationId(Long destinationId)

Sets the id for the folder

Parameters:

destinationId - the destination id

Returns:

the builder

getNewName

public String getNewName()

Gets the destination name when copying or moving a Sheet or a Folder.

Returns:

the new name

setNewName

public ContainerDestination.AddContainerDestinationBuilder setNewName(String newName)

Sets the name for the folder

Parameters:

newName - the new name for destination

Returns:

the builder

build

public ContainerDestination build()

Builds the comment.

Returns:

the comment