ExtDocumentTreeNode (Jama Enterprise Edition)

java.lang.Object
- com.jamasoftware.contour.service.dto.ExtDocumentTreeNode

All Implemented Interfaces:

com.jamasoftware.contour.util.hierarchy.HierarchyNode<ExtDocumentTreeNode>

Direct Known Subclasses:

ExtDocumentCheckedTreeNode, ExtDocumentReleaseTreeNode
```
public class ExtDocumentTreeNode
extends Object
implements com.jamasoftware.contour.util.hierarchy.HierarchyNode<ExtDocumentTreeNode>
```
Ext tree node for a document/item.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ExtDocumentTreeNode.TreeNodeCategory`
`static class`	`ExtDocumentTreeNode.TreeNodeKey` Enumeration of the EXT tree node keys used for this application.

Nested classes/interfaces inherited from interface com.jamasoftware.contour.util.hierarchy.HierarchyNode
com.jamasoftware.contour.util.hierarchy.HierarchyNode.DocumentHierarchyNode, com.jamasoftware.contour.util.hierarchy.HierarchyNode.ProjectableHierarchyNode<T extends com.jamasoftware.contour.util.hierarchy.HierarchyNode<T>>, com.jamasoftware.contour.util.hierarchy.HierarchyNode.VersionHierarchyNode

Field Summary

Fields
Modifier and Type Field and Description

static String TREE_KEY_SEPARATOR

static String TREE_PATH_SEPARATOR

Fields
Modifier and Type	Field and Description
`static String`	`TREE_KEY_SEPARATOR`
`static String`	`TREE_PATH_SEPARATOR`

Constructor Summary

Constructors
Constructor and Description
`ExtDocumentTreeNode()`
`ExtDocumentTreeNode(String id, String text, String icon, Boolean leaf)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addCls(String classToAdd)`
`static String`	`buildTreeNodeId(ExtDocumentTreeNode.TreeNodeKey key, Object... ids)` Concatenates a `ExtDocumentTreeNode.TreeNodeKey.getKey()` with `TREE_KEY_SEPARATOR`, followed by an id, for each id.
`Integer`	`getBaseLineId()`
`Integer`	`getBaseLineRefId()`
`Integer`	`getBaseLineScopeId()`
`Boolean`	`getCanInferChildType()`
`DocumentTypeCategory`	`getChildDocumentTypeCategory()`
`String`	`getChildDocumentTypeDisplayPlural()`
`String`	`getChildDocumentTypeIcon()`
`Integer`	`getChildDocumentTypeId()`
`Boolean`	`getChildDocumentTypeIsSystemType()`
`List<ExtDocumentTreeNode>`	`getChildren()`
`String`	`getCls()`
`String`	`getDocumentKey()`
`Boolean`	`getDraggable()`
`Boolean`	`getEditable()`
`String`	`getFolderIdPath()`
`String`	`getFolderPath()`
`String`	`getIcon()`
`String`	`getIconCls()`
`String`	`getId()`
`boolean`	`getIsDisabled()`
`Boolean`	`getIsFolder()`
`String`	`getKey()`
`Boolean`	`getLeaf()`
`boolean`	`getLoaded()`
`Boolean`	`getLocked()`
`Integer`	`getLockedById()`
`String`	`getName()`
`String`	`getParentId()`
`Integer`	`getProjectId()`
`String`	`getQtip()`
`String`	`getSetKey()`
`Integer`	`getSortOrder()`
`Boolean`	`getSystemLocked()`
`String`	`getText()`
`DocumentTypeCategory`	`getTypeCategory()`
`String`	`getTypeDisplay()`
`String`	`getTypeDisplayPlural()`
`Integer`	`getTypeId()`
`Boolean`	`getTypeIsSystemType()`
`List<Integer>`	`getValidChildTypeIds()`
`void`	`hideIcon()` Adds a CSS class to hide icons, and sets the icon image to be blank
`boolean`	`isSyncItem()`
`static Integer`	`parseNodeId(String nodeId)` return the numeric id from string ids of format: a-3, or b-3-123456789
`void`	`setBaseLineId(Integer baseLineId)`
`void`	`setBaseLineRefId(Integer baseLineRefId)`
`void`	`setBaseLineScopeId(Integer baseLineScopeId)`
`void`	`setCanInferChildType(Boolean canInferChildType)`
`void`	`setChildDocumentTypeCategory(DocumentTypeCategory childDocumentTypeCategory)`
`void`	`setChildDocumentTypeDisplayPlural(String childDocumentTypeDisplayPlural)`
`void`	`setChildDocumentTypeIcon(String childDocumentTypeIcon)`
`void`	`setChildDocumentTypeId(Integer childDocumentTypeId)`
`void`	`setChildDocumentTypeIsSystemType(Boolean childDocumentTypeIsSystemType)`
`void`	`setChildren(List<ExtDocumentTreeNode> children)`
`void`	`setCls(String cls)`
`void`	`setDisabledMessage(String disabledMessage)` Uses `setCls(String)` and `setQtip(String)` to make the node appear disabled with a tooltip notification
`void`	`setDocumentKey(String documentKey)`
`void`	`setDraggable(Boolean draggable)`
`void`	`setEditable(Boolean editable)`
`void`	`setFolderIdPath(String folderIdPath)`
`void`	`setFolderPath(String folderPath)`
`void`	`setIcon(String icon)`
`void`	`setIconCls(String iconCls)`
`void`	`setId(String id)`
`void`	`setIsDisabled(boolean isDisabled)`
`void`	`setIsFolder(Boolean isFolder)`
`void`	`setKey(String key)`
`void`	`setLeaf(Boolean leaf)`
`void`	`setLoaded(boolean loaded)`
`void`	`setLocked(Boolean locked)`
`void`	`setLockedById(Integer lockedById)`
`void`	`setName(String name)`
`void`	`setParentId(String parentId)`
`void`	`setProjectId(Integer projectId)`
`void`	`setQtip(String qtip)`
`void`	`setSetKey(String setKey)`
`void`	`setSortOrder(Integer sortOrder)`
`void`	`setSyncItem(boolean isSyncItem)`
`void`	`setSystemLocked(Boolean systemLocked)`
`void`	`setText(String text)`
`void`	`setTypeCategory(DocumentTypeCategory typeCategory)`
`void`	`setTypeDisplay(String typeDisplay)`
`void`	`setTypeDisplayPlural(String typeDisplayPlural)`
`void`	`setTypeId(Integer typeId)`
`void`	`setTypeIsSystemType(Boolean typeIsSystemType)`
`void`	`setValidChildTypeIds(List<Integer> validChildTypeIds)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail
- TREE_KEY_SEPARATOR
```
public static final String TREE_KEY_SEPARATOR
```
  See Also:
  Constant Field Values
- TREE_PATH_SEPARATOR
```
public static final String TREE_PATH_SEPARATOR
```
  See Also:
  Constant Field Values

Constructor Detail

ExtDocumentTreeNode
```
public ExtDocumentTreeNode()
```

ExtDocumentTreeNode

public ExtDocumentTreeNode(String id,
                   String text,
                   String icon,
                   Boolean leaf)

Method Detail

buildTreeNodeId
```
public static String buildTreeNodeId(ExtDocumentTreeNode.TreeNodeKey key,
                     Object... ids)
```
Concatenates a ExtDocumentTreeNode.TreeNodeKey.getKey() with TREE_KEY_SEPARATOR, followed by an id, for each id.

Parameters:
key - A ExtDocumentTreeNode.TreeNodeKey
ids - A collection of ids to separate with TREE_KEY_SEPARATOR

Returns:
A string to be used as a tree node id

parseNodeId
```
public static Integer parseNodeId(String nodeId)
```
return the numeric id from string ids of format: a-3, or b-3-123456789

Parameters:
nodeId -

Returns:
String id

getIcon
```
public String getIcon()
```

setIcon
```
public void setIcon(String icon)
```

getIconCls
```
public String getIconCls()
```

setIconCls

public void setIconCls(String iconCls)

getId
```
public String getId()
```

setId
```
public void setId(String id)
```

getText
```
public String getText()
```

setText
```
public void setText(String text)
```

getLeaf
```
public Boolean getLeaf()
```

setLeaf
```
public void setLeaf(Boolean leaf)
```

getDocumentKey
```
public String getDocumentKey()
```

setDocumentKey

public void setDocumentKey(String documentKey)

getName
```
public String getName()
```

setName
```
public void setName(String name)
```

getProjectId
```
public Integer getProjectId()
```

setProjectId

public void setProjectId(Integer projectId)

getTypeId
```
public Integer getTypeId()
```

setTypeId

public void setTypeId(Integer typeId)

getLocked
```
public Boolean getLocked()
```

setLocked

public void setLocked(Boolean locked)

getLockedById
```
public Integer getLockedById()
```

setLockedById

public void setLockedById(Integer lockedById)

getSystemLocked
```
public Boolean getSystemLocked()
```

setSystemLocked

public void setSystemLocked(Boolean systemLocked)

getEditable
```
public Boolean getEditable()
```

setEditable

public void setEditable(Boolean editable)

getTypeDisplay
```
public String getTypeDisplay()
```

setTypeDisplay

public void setTypeDisplay(String typeDisplay)

getParentId
```
public String getParentId()
```

setParentId

public void setParentId(String parentId)

getTypeDisplayPlural
```
public String getTypeDisplayPlural()
```

setTypeDisplayPlural

public void setTypeDisplayPlural(String typeDisplayPlural)

getKey
```
public String getKey()
```

setKey
```
public void setKey(String key)
```

getChildren
```
public List<ExtDocumentTreeNode> getChildren()
```
Specified by:

getChildren in interface com.jamasoftware.contour.util.hierarchy.HierarchyNode<ExtDocumentTreeNode>

setChildren
```
public void setChildren(List<ExtDocumentTreeNode> children)
```
Specified by:

setChildren in interface com.jamasoftware.contour.util.hierarchy.HierarchyNode<ExtDocumentTreeNode>

getBaseLineScopeId
```
public Integer getBaseLineScopeId()
```
Returns:
the baseLineScopeId

setBaseLineScopeId
```
public void setBaseLineScopeId(Integer baseLineScopeId)
```
Parameters:
baseLineScopeId - the baseLineScopeId to set

getBaseLineRefId
```
public Integer getBaseLineRefId()
```
Returns:
the baseLineRefId

setBaseLineRefId
```
public void setBaseLineRefId(Integer baseLineRefId)
```
Parameters:
baseLineRefId - the baseLineRefId to set

getIsFolder
```
public Boolean getIsFolder()
```
Returns:
if the node is a folder

setIsFolder
```
public void setIsFolder(Boolean isFolder)
```
Parameters:
isFolder - is the node a folder

getLoaded
```
public boolean getLoaded()
```

setLoaded

public void setLoaded(boolean loaded)

getBaseLineId
```
public Integer getBaseLineId()
```

setBaseLineId

public void setBaseLineId(Integer baseLineId)

getValidChildTypeIds

public List<Integer> getValidChildTypeIds()

setValidChildTypeIds

public void setValidChildTypeIds(List<Integer> validChildTypeIds)

getChildDocumentTypeId

public Integer getChildDocumentTypeId()

setChildDocumentTypeId

public void setChildDocumentTypeId(Integer childDocumentTypeId)

getChildDocumentTypeDisplayPlural

public String getChildDocumentTypeDisplayPlural()

setChildDocumentTypeDisplayPlural

public void setChildDocumentTypeDisplayPlural(String childDocumentTypeDisplayPlural)

getCls
```
public String getCls()
```

setCls
```
public void setCls(String cls)
```

getQtip
```
public String getQtip()
```

setQtip
```
public void setQtip(String qtip)
```

getSortOrder
```
public Integer getSortOrder()
```

setSortOrder

public void setSortOrder(Integer sortOrder)

getIsDisabled
```
public boolean getIsDisabled()
```

setIsDisabled

public void setIsDisabled(boolean isDisabled)

getCanInferChildType
```
public Boolean getCanInferChildType()
```

setCanInferChildType

public void setCanInferChildType(Boolean canInferChildType)

setSetKey
```
public void setSetKey(String setKey)
```

getSetKey
```
public String getSetKey()
```

setDisabledMessage
```
public void setDisabledMessage(String disabledMessage)
```
Uses setCls(String) and setQtip(String) to make the node appear disabled with a tooltip notification

addCls

public void addCls(String classToAdd)

hideIcon
```
public void hideIcon()
```
Adds a CSS class to hide icons, and sets the icon image to be blank

toString
```
public String toString()
```
Overrides:

toString in class Object

Returns:
a String representation of this object.

getChildDocumentTypeIcon

public String getChildDocumentTypeIcon()

setChildDocumentTypeIcon

public void setChildDocumentTypeIcon(String childDocumentTypeIcon)

getDraggable
```
public Boolean getDraggable()
```

setDraggable

public void setDraggable(Boolean draggable)

getTypeCategory

public DocumentTypeCategory getTypeCategory()

setTypeCategory

public void setTypeCategory(DocumentTypeCategory typeCategory)

getChildDocumentTypeCategory

public DocumentTypeCategory getChildDocumentTypeCategory()

setChildDocumentTypeCategory

public void setChildDocumentTypeCategory(DocumentTypeCategory childDocumentTypeCategory)

getTypeIsSystemType
```
public Boolean getTypeIsSystemType()
```

setTypeIsSystemType

public void setTypeIsSystemType(Boolean typeIsSystemType)

getChildDocumentTypeIsSystemType

public Boolean getChildDocumentTypeIsSystemType()

setChildDocumentTypeIsSystemType

public void setChildDocumentTypeIsSystemType(Boolean childDocumentTypeIsSystemType)

getFolderIdPath
```
public String getFolderIdPath()
```

setFolderIdPath

public void setFolderIdPath(String folderIdPath)

getFolderPath
```
public String getFolderPath()
```

setFolderPath

public void setFolderPath(String folderPath)

isSyncItem
```
public boolean isSyncItem()
```

setSyncItem

public void setSyncItem(boolean isSyncItem)

Class ExtDocumentTreeNode

Nested Class Summary

Nested classes/interfaces inherited from interface com.jamasoftware.contour.util.hierarchy.HierarchyNode

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TREE_KEY_SEPARATOR

TREE_PATH_SEPARATOR

Constructor Detail

ExtDocumentTreeNode

ExtDocumentTreeNode

Method Detail

buildTreeNodeId

parseNodeId

getIcon

setIcon

getIconCls

setIconCls

getId

setId

getText

setText

getLeaf

setLeaf

getDocumentKey

setDocumentKey

getName

setName

getProjectId

setProjectId

getTypeId

setTypeId

getLocked

setLocked

getLockedById

setLockedById

getSystemLocked

setSystemLocked

getEditable

setEditable

getTypeDisplay

setTypeDisplay

getParentId

setParentId

getTypeDisplayPlural

setTypeDisplayPlural

getKey

setKey

getChildren

setChildren

getBaseLineScopeId

setBaseLineScopeId

getBaseLineRefId

setBaseLineRefId

getIsFolder

setIsFolder

getLoaded

setLoaded

getBaseLineId

setBaseLineId

getValidChildTypeIds

setValidChildTypeIds

getChildDocumentTypeId

setChildDocumentTypeId

getChildDocumentTypeDisplayPlural

setChildDocumentTypeDisplayPlural

getCls

setCls

getQtip

setQtip

getSortOrder

setSortOrder

getIsDisabled

setIsDisabled

getCanInferChildType

setCanInferChildType

setSetKey

getSetKey