Class MenuTree
java.lang.Object
com.appiancorp.suiteapi.collaboration.MenuTree
- All Implemented Interfaces:
LocalId
,Serializable
,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
Modifier and TypeFieldDescriptionstatic final Integer
Deprecated.Sort by the Creator propertystatic final Integer
Deprecated.Sort by the ID propertystatic final Integer
Deprecated.Sort by the Knowledge Center ID propertystatic final Integer
Deprecated.Sort by the Name propertystatic final Integer
Deprecated.Sort by the Parent ID propertystatic final Integer
Deprecated.Sort by the Type propertystatic final Integer
Deprecated.Sort by the User Access property -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionclone()
Deprecated.Deprecated.Gets the user who created the entitygetId()
Deprecated.Gets the unique ID of the entity that thisMenuTree
representsDeprecated.Gets the unique ID of the knowledge center which the entity belongs to.getName()
Deprecated.Gets the name of the entity that thisMenuTree
representsDeprecated.Gets the unique ID of the parent of the entity that thisMenuTree
representsgetType()
Deprecated.Gets the type of the entity that thisMenuTree
represents.Deprecated.Retrieves the access permissions that the user has for the entity that thisMenuTree
represents.void
setCreator
(String creator) Deprecated.Gets the user who created the entityvoid
Deprecated.Gets the unique ID of the entity that thisMenuTree
representsvoid
setKnowledgeCenterId
(Long kcid) Deprecated.Sets the unique ID of the knowledge center which the entity belongs to.void
Deprecated.Gets the name of the entity that thisMenuTree
representsvoid
setParentId
(Long pid) Deprecated.Sets the unique ID of the parent of the entity that thisMenuTree
representsvoid
Deprecated.Sets the type of the entity that thisMenuTree
represents.void
setUserAccess
(Long useraccess) Deprecated.Sets the access permissions that the user has for the entity that thisMenuTree
represents.
-
Field Details
-
SORT_BY_ID
Deprecated.Sort by the ID property -
SORT_BY_PARENT_ID
Deprecated.Sort by the Parent ID property -
SORT_BY_NAME
Deprecated.Sort by the Name property -
SORT_BY_TYPE
Deprecated.Sort by the Type property -
SORT_BY_KNOWLEDGE_CENTER_ID
Deprecated.Sort by the Knowledge Center ID property -
SORT_BY_CREATOR
Deprecated.Sort by the Creator property -
SORT_BY_USER_ACCESS
Deprecated.Sort by the User Access property
-
-
Constructor Details
-
MenuTree
public MenuTree()Deprecated.
-
-
Method Details
-
getCreator
Deprecated.Gets the user who created the entity- Returns:
- the unique ID of the user who created the entity
-
getId
Deprecated.Gets the unique ID of the entity that thisMenuTree
represents -
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
Deprecated.Gets the name of the entity that thisMenuTree
represents- Returns:
- the name of the entity
-
getParentId
Deprecated.Gets the unique ID of the parent of the entity that thisMenuTree
represents- Returns:
- the unique ID of the parent of the entity
-
getType
Deprecated.Gets the type of the entity that thisMenuTree
represents.- Returns:
- a number corresponding to one of the following values :
0 = knowledge center
,1 = community
,2 = normal folder
,3 = top-level folder
-
getUserAccess
Deprecated.Retrieves the access permissions that the user has for the entity that thisMenuTree
represents.- Returns:
- a number corresponding to one of the following values :
0 = read-only
,1 = author (read/write)
,2 = adminstrator
,3 = no access
-
setCreator
Deprecated.Gets the user who created the entity- Parameters:
creator
- the unique ID of the user who created the entity
-
setId
Deprecated.Gets the unique ID of the entity that thisMenuTree
represents -
setKnowledgeCenterId
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
Deprecated.Gets the name of the entity that thisMenuTree
represents- Parameters:
name
- the name of the entity
-
setParentId
Deprecated.Sets the unique ID of the parent of the entity that thisMenuTree
represents- Parameters:
pid
- the unique ID of the parent of the entity
-
setType
Deprecated.Sets the type of the entity that thisMenuTree
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
Deprecated.Sets the access permissions that the user has for the entity that thisMenuTree
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
Deprecated.- Overrides:
clone
in classObject
- Throws:
CloneNotSupportedException
-