Package com.smartsheet.api.models
Class SheetPathNode
- java.lang.Object
-
- com.smartsheet.api.models.IdentifiableModel<T>
-
- com.smartsheet.api.models.NamedModel<java.lang.Long>
-
- com.smartsheet.api.models.PathNode
-
- com.smartsheet.api.models.SheetPathNode
-
public class SheetPathNode extends PathNode
Node in a sheet path response. Contains recursive folders leading to the target sheet.
-
-
Constructor Summary
Constructors Constructor Description SheetPathNode()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.List<SheetPathNode>getFolders()PathLeafgetLeafSheet()Walks down through folders until a node contains sheets, then returns the first sheet.java.lang.StringgetLeafSheetPath()Returns a UNIX style/-joined path of folder names plus the target sheet name.java.util.List<PathLeaf>getSheets()SheetPathNodesetFolders(java.util.List<SheetPathNode> folders)SheetPathNodesetSheets(java.util.List<PathLeaf> sheets)-
Methods inherited from class com.smartsheet.api.models.PathNode
getAccessLevel, getPermalink, setAccessLevel, setPermalink
-
Methods inherited from class com.smartsheet.api.models.NamedModel
getName, setName
-
Methods inherited from class com.smartsheet.api.models.IdentifiableModel
equals, getId, hashCode, setId
-
-
-
-
Method Detail
-
getFolders
public java.util.List<SheetPathNode> getFolders()
-
setFolders
public SheetPathNode setFolders(java.util.List<SheetPathNode> folders)
- Parameters:
folders- the list of nested folder nodes; may be null
-
getSheets
public java.util.List<PathLeaf> getSheets()
-
setSheets
public SheetPathNode setSheets(java.util.List<PathLeaf> sheets)
- Parameters:
sheets- the list of sheet leaf nodes within this folder; may be null
-
getLeafSheet
public PathLeaf getLeafSheet()
Walks down through folders until a node contains sheets, then returns the first sheet.
-
getLeafSheetPath
public java.lang.String getLeafSheetPath()
Returns a UNIX style/-joined path of folder names plus the target sheet name.Examples:
- Workspace → Folder → Sheet returns
"/Workspace/Folder/Sheet" - Workspace → Sheet (no intermediate folders) returns
"/Workspace/Sheet"
- Workspace → Folder → Sheet returns
-
-