Package com.appiancorp.suiteapi.collaboration

Class MenuTree

java.lang.Object
com.appiancorp.suiteapi.collaboration.MenuTree
All Implemented Interfaces:
LocalId, Serializable, Cloneable
@Deprecated public class MenuTree extends Object implements LocalId, Cloneable
Deprecated.

This class represents a fragment of the collaboration application's navigation bar menutree, and corresponds to an entity in the application (a knowledge center, community, folder, or document)

Copyright: Copyright (c) 2002, 2003

Company: Appian Corporation

See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final Integer
    SORT_BY_CREATOR
    Deprecated.
    Sort by the Creator property
    static final Integer
    SORT_BY_ID
    Deprecated.
    Sort by the ID property
    static final Integer
    SORT_BY_KNOWLEDGE_CENTER_ID
    Deprecated.
    Sort by the Knowledge Center ID property
    static final Integer
    SORT_BY_NAME
    Deprecated.
    Sort by the Name property
    static final Integer
    SORT_BY_PARENT_ID
    Deprecated.
    Sort by the Parent ID property
    static final Integer
    SORT_BY_TYPE
    Deprecated.
    Sort by the Type property
    static final Integer
    SORT_BY_USER_ACCESS
    Deprecated.
    Sort by the User Access property

  • Constructor Summary

    Constructors
    Constructor
    Description
    MenuTree()
    Deprecated.
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    clone()
    Deprecated.
     
    String
    getCreator()
    Deprecated.
    Gets the user who created the entity
    Long
    getId()
    Deprecated.
    Gets the unique ID of the entity that this MenuTree represents
    Long
    getKnowledgeCenterId()
    Deprecated.
    Gets the unique ID of the knowledge center which the entity belongs to.
    String
    getName()
    Deprecated.
    Gets the name of the entity that this MenuTree represents
    Long
    getParentId()
    Deprecated.
    Gets the unique ID of the parent of the entity that this MenuTree represents
    Long
    getType()
    Deprecated.
    Gets the type of the entity that this MenuTree represents.
    Long
    getUserAccess()
    Deprecated.
    Retrieves the access permissions that the user has for the entity that this MenuTree represents.
    void
    setCreator(String creator)
    Deprecated.
    Gets the user who created the entity
    void
    setId(Long id)
    Deprecated.
    Gets the unique ID of the entity that this MenuTree represents
    void
    setKnowledgeCenterId(Long kcid)
    Deprecated.
    Sets the unique ID of the knowledge center which the entity belongs to.
    void
    setName(String name)
    Deprecated.
    Gets the name of the entity that this MenuTree represents
    void
    setParentId(Long pid)
    Deprecated.
    Sets the unique ID of the parent of the entity that this MenuTree represents
    void
    setType(Long type)
    Deprecated.
    Sets the type of the entity that this MenuTree represents.
    void
    setUserAccess(Long useraccess)
    Deprecated.
    Sets the access permissions that the user has for the entity that this MenuTree represents.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • SORT_BY_ID

      public static final Integer SORT_BY_ID
      Deprecated.
      Sort by the ID property

    • SORT_BY_PARENT_ID

      public static final Integer SORT_BY_PARENT_ID
      Deprecated.
      Sort by the Parent ID property

    • SORT_BY_NAME

      public static final Integer SORT_BY_NAME
      Deprecated.
      Sort by the Name property

    • SORT_BY_TYPE

      public static final Integer SORT_BY_TYPE
      Deprecated.
      Sort by the Type property

    • SORT_BY_KNOWLEDGE_CENTER_ID

      public static final Integer SORT_BY_KNOWLEDGE_CENTER_ID
      Deprecated.
      Sort by the Knowledge Center ID property

    • SORT_BY_CREATOR

      public static final Integer SORT_BY_CREATOR
      Deprecated.
      Sort by the Creator property

    • SORT_BY_USER_ACCESS

      public static final Integer SORT_BY_USER_ACCESS
      Deprecated.
      Sort by the User Access property

  • Constructor Details

    • MenuTree

      public MenuTree()
      Deprecated.

  • Method Details

    • getCreator

      public String getCreator()
      Deprecated.
      Gets the user who created the entity
      Returns:
      the unique ID of the user who created the entity

    • getId

      public Long getId()
      Deprecated.
      Gets the unique ID of the entity that this MenuTree represents
      Specified by:
      getId in interface LocalId
      Returns:
      the unique ID of the entity
      See Also:

    • getKnowledgeCenterId

      public Long getKnowledgeCenterId()
      Deprecated.
      Gets the unique ID of the knowledge center which the entity belongs to. If the entity is itself a knowledge center, this method returns the ID of the entity
      Returns:
      the unique ID of the knowledge center

    • getName

      public String getName()
      Deprecated.
      Gets the name of the entity that this MenuTree represents
      Returns:
      the name of the entity

    • getParentId

      public Long getParentId()
      Deprecated.
      Gets the unique ID of the parent of the entity that this MenuTree represents
      Returns:
      the unique ID of the parent of the entity

    • getType

      public Long getType()
      Deprecated.
      Gets the type of the entity that this MenuTree represents.
      Returns:
      a number corresponding to one of the following values : 0 = knowledge center, 1 = community, 2 = normal folder, 3 = top-level folder

    • getUserAccess

      public Long getUserAccess()
      Deprecated.
      Retrieves the access permissions that the user has for the entity that this MenuTree represents.
      Returns:
      a number corresponding to one of the following values : 0 = read-only, 1 = author (read/write), 2 = adminstrator, 3 = no access

    • setCreator

      public void setCreator(String creator)
      Deprecated.
      Gets the user who created the entity
      Parameters:
      creator - the unique ID of the user who created the entity

    • setId

      public void setId(Long id)
      Deprecated.
      Gets the unique ID of the entity that this MenuTree represents
      Specified by:
      setId in interface LocalId
      Parameters:
      id - the unique ID of the entity
      See Also:

    • setKnowledgeCenterId

      public void setKnowledgeCenterId(Long kcid)
      Deprecated.
      Sets the unique ID of the knowledge center which the entity belongs to. If the entity is itself a knowledge center, value should be set to the ID of the entity
      Parameters:
      kcid - the unique ID of the knowledge center

    • setName

      public void setName(String name)
      Deprecated.
      Gets the name of the entity that this MenuTree represents
      Parameters:
      name - the name of the entity

    • setParentId

      public void setParentId(Long pid)
      Deprecated.
      Sets the unique ID of the parent of the entity that this MenuTree represents
      Parameters:
      pid - the unique ID of the parent of the entity

    • setType

      public void setType(Long type)
      Deprecated.
      Sets the type of the entity that this MenuTree represents.
      Parameters:
      type - a number corresponding to one of the following values : 0 = knowledge center, 1 = community, 2 = normal folder, 3 = top-level folder

    • setUserAccess

      public void setUserAccess(Long useraccess)
      Deprecated.
      Sets the access permissions that the user has for the entity that this MenuTree represents.
      Parameters:
      useraccess - a number corresponding to one of the following values : 0 = read-only, 1 = author (read/write), 2 = adminstrator, 3 = no access

    • clone

      public Object clone() throws CloneNotSupportedException
      Deprecated.
      Overrides:
      clone in class Object
      Throws:
      CloneNotSupportedException