com.smartsheet.api.models

Class Favorite

java.lang.Object

com.smartsheet.api.models.Favorite

public class Favorite
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Favorite.AddFavoriteBuilder A convenience class for making a Favorite object with the appropriate fields for adding to a Favorite.

Constructor Summary

Constructors

Constructor and Description
Favorite()

Method Summary

Modifier and Type	Method and Description
Long	getObjectId() Gets the ID of the favorited item.
FavoriteType	getType() Gets the type of favorite (workspace, folder, sheet, report, template).
Favorite	setObjectId(Long objectId) Sets the ID of the favorited item.
Favorite	setType(FavoriteType type) Sets the type of favorite (workspace, folder, sheet, report, template).

Methods inherited from class java.lang.Object

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

Constructor Detail

Favorite

public Favorite()

Method Detail

getObjectId

public Long getObjectId()

Gets the ID of the favorited item.

Returns:

the objectId

setObjectId

public Favorite setObjectId(Long objectId)

Sets the ID of the favorited item.

Parameters:

objectId - ID of the favorited item.

getType

public FavoriteType getType()

Gets the type of favorite (workspace, folder, sheet, report, template).

Returns:

the type

setType

public Favorite setType(FavoriteType type)

Sets the type of favorite (workspace, folder, sheet, report, template).

Parameters:

type - the new dependencies enabled