 | Aqualogic Interaction API | ||
IPTSiteMapFolder Members | |||
| Aqualogic Interaction API | ||
IPTSiteMapFolder Members | |||
 CreateLink | Create a new link that will be in the current folder. The link does not get stored until IPTSiteMapLink.Store() is called. User must have edit access to the current folder. |
| CreateSubfolder | Create a new folder that will be a child of the current folder. User must have edit access to the current folder. |
| DeleteLink | Delete link in the current folder. User must have edit access to the current folder. |
| GetFolderDepth | Get the folder depth. The root folder has a depth of 1. |
| GetGID | Return the GID, or genealogical ID. This is the full path all the folders above this folder, with all of the object ID's of the parent folders. Each folder id is delimited by '/' and the id's appear in the order that they are in the hierarchy. |
| GetParentFolderID | Get the current folder's parent folder id. |
| GetPath | Get all the names of the parent folders above the current folder, from the root first, to the current folder's parent last. Each name is delimited by "\\". |
| OpenLink | Open a link in the current folder. User must have read access to the current folder. |
| QueryLinks | Query for all the links inside this folder that are visible to the current user. For instance, if there is a document link in this folder and the user does not have at least read access to the document, it will not show up. All web links are visible for all users (provided they have at lest read access to this folder). |
| QuerySubfolders | Query for all the child folders inside this folder and if the boolean is true, get all the children's children as well. Only folder that the current user has at least read access to will be returned. |
| QuerySubfoldersRecursive | Query for all the folders beneath this folder in the tree. This does not check for security, but only returns object ids in the query result, so it is not a security hole. This function is used within the API by IPTSiteMapFolderManager.RecursiveDelete(). |
| SetParent | Set the parent folder of this folder. Because a folder is created by a folder of another folder, this function implements move functionality. |
IPTSiteMapFolder Interface | com.plumtree.server Namespace