Package com.seeq.model
Class WorkbookInputV1
java.lang.Object
com.seeq.model.WorkbookInputV1
WorkbookInputV1
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbranchFrom
(String branchFrom) description
(String description) boolean
Create a new workbook by duplicating the contents and history of the workbook with the specified ID.Clarifying information or other plain language description of this item.The id of the folder to place the new workbook into.getName()
Human readable name.The ID of the User that owns this workbook.getType()
The type of workbook, either 'Analysis' or 'Topic'.int
hashCode()
void
setBranchFrom
(String branchFrom) void
setDescription
(String description) void
setFolderId
(String folderId) void
void
setOwnerId
(String ownerId) void
toString()
-
Constructor Details
-
WorkbookInputV1
public WorkbookInputV1()
-
-
Method Details
-
branchFrom
-
getBranchFrom
Create a new workbook by duplicating the contents and history of the workbook with the specified ID. When null, no branching will occur; resulting workbook will be empty.- Returns:
- branchFrom
-
setBranchFrom
-
description
-
getDescription
Clarifying information or other plain language description of this item. An input of just whitespaces is equivalent to a null input.- Returns:
- description
-
setDescription
-
folderId
-
getFolderId
The id of the folder to place the new workbook into. Special values of 'mine' or 'corporate' to place the item in the authenticated user's home folder or the corporate folder, respectively. If null, the workbook will be created in the authenticated user's home folder.- Returns:
- folderId
-
setFolderId
-
name
-
getName
Human readable name. Required during creation. An input of just whitespaces is equivalent to a null input.- Returns:
- name
-
setName
-
ownerId
-
getOwnerId
The ID of the User that owns this workbook. If omitted when creating a new Workbook, the authenticated user is used by default. Only administrators may set this value.- Returns:
- ownerId
-
setOwnerId
-
type
-
getType
The type of workbook, either 'Analysis' or 'Topic'. Defaults to 'Analysis'.- Returns:
- type
-
setType
-
equals
-
hashCode
public int hashCode() -
toString
-