Package com.saperion.ngc.model.navigation.intf

Interface NavigationNode

All Superinterfaces:
NavigationItem, Serializable
All Known Implementing Classes:
FolderNode
public interface NavigationNode extends NavigationItem
Navigation node.
Author:
mak

  • Method Details

    • getParent

      NavigationItem getParent()
      Returns the parent navigation item (node or tree).
      Returns:
      NavigationItem

    • setParent

      void setParent(NavigationItem parentItem)
      Sets a new parent to a Node.
      Parameters:
      parentItem - The new parentItem.

    • getDisplayName

      String getDisplayName()
      Returns the node/folder name to display on frontend.
      Returns:
      the node display name

    • getQueryFormName

      String getQueryFormName()
      Returns the query form name.
      Returns:
      the query form name

    • getMaskDDCName

      String getMaskDDCName()
      Returns the mask ddc name.
      Returns:
      Form DDC name

    • getIndexFormName

      String getIndexFormName()
      Returns the index form name.
      Returns:
      the index form name

    • getLinkFolder

      String getLinkFolder()
      Returns the link folder id.
      Returns:
      the linkFolder

    • getLinkTable

      String getLinkTable()
      Returns the link table.
      Returns:
      the linkTable

    • getId

      FolderId getId()
      Returns the node/folder identifier.
      Returns:
      the navigation node's id

    • setId

      void setId(FolderId folderId)
      Sets the ID of this node.
      Parameters:
      folderId - node id

    • setName

      void setName(String nodeName)
      Sets the node name.
      Parameters:
      nodeName - Name

    • getType

      com.saperion.constants.SaFolderConstants.FOLDER_TYPE getType()
      Returns folder type.
      Returns:
      folder type

    • getContent

      InputStream getContent() throws BinaryUnavailableException, AuthenticationException
      Returns the content stream, it will be loaded on demand.
      Returns:
      content
      Throws:
      AuthenticationException - AuthenticationException
      BinaryUnavailableException - BinaryUnavailableException

    • setContent

      void setContent(InputStream content)
      Sets the content stream.
      Parameters:
      content - content

    • getPath

      String getPath()
      Returns:
      the node path

    • getDocCount

      long getDocCount()
      Returns:
      Document count

    • setDocCount

      void setDocCount(int count)
      Sets the number of documents enclosed by this folder.
      Parameters:
      count - the number of documents enclosed by this folder.

    • getUnreadCount

      long getUnreadCount()
      Returns:
      Document count

    • setUnreadCount

      void setUnreadCount(long count)
      Sets the number of unread documents enclosed by this folder.
      Parameters:
      count - the number of unread documents enclosed by this folder.

    • canMove

      boolean canMove()
      Returns:
      Can move.

    • getUploadInfos

      FolderUploadInfos getUploadInfos()
      Returns:
      information about the upload capabilities of the node

    • getFolderClass

      FolderClass getFolderClass()
      Returns the folder class. If no class is defined, a GenericFolderClass is generated.
      Returns:
      the folder class

    • getProperties

      Map<String,String> getProperties()
      Returns the properties of the folder. The properties do not contain system properties.
      Returns:
      folder properties

    • setWorkflowInfo

      void setWorkflowInfo(WorkflowNodeInfo info)
      Parameters:
      info - Set the workflow infomation's

    • getWorkflowInfo

      WorkflowNodeInfo getWorkflowInfo()
      Returns:
      The workflow infomation's

    • isLinked

      boolean isLinked()
      Returns:
      true if this node is linked by another node

    • getLinkingNode

      NavigationNode getLinkingNode()
      Returns:
      the node that links to this node or null if this node is not linked

    • setLinkingNode

      void setLinkingNode(NavigationNode linking)
      Sets the node that is linking to this node.
      Parameters:
      linking - the linking node

    • isInPrivateSubtree

      boolean isInPrivateSubtree()
      Checks if the node is located within a private-subtree of the navigation tree.
      Returns:
      true if node is in private subtree