Home >	Contents >	Index >

Expanded TOC   |    Accordion TOC   |    Annotated TOC   |    Index

ICS.TreeManager

Executes a TreeManager command.

This method has two variants:

• TreeManager (Variant 1) executes TreeManager commands.

• TreeManager (Variant 2) executes TreeManager commands and accepts a handle for the BatchContext object.

For more information on the various TreeManager commands, see the TreeManager command in the CS Developer's Tag Reference.

Several TREEMANAGER commands (addchild, addchildren, findnode, getchildren, getnode, getparent, listtrees, and nodepath) return a list. Each of those commands has a treename argument. The name of the returned list is the value passed as the treename argument.

The following columns are common to every list returned by a TreeManager command:

Column Name	What it Holds
nid	Tree node ID.
nparentid	Parent tree node ID. 0 (zero) means it is a root node.
nrank	Application-specific rank of the node.
otype	Object table referenced by this node.
oid	Object ID referenced by this node.
oversion	Reserved for future use by FatWire.
ncode	Application-specific code related to the node.

 

---

ICS.TreeManager

Use this method to execute a TreeManager command. A list of available commands follows:

addchild	delchildren	getnode	nodepath
addchildren	deletetree	getparent	setobject
copychild	findnode	listtrees	validatenode
createtree	getchildren	movechild	verifypath
delchild

 

For more information on the various TreeManager commands, see the TreeManager command in the CS Developer's Tag Reference.

Syntax

public boolean 
TreeManager(FTValList vIn)

Parameters

vIn

List of name/value pairs passed to TreeManager. The ftcmd parameter is required and specifies the specific TreeManager command to execute. Any other parameters depend on the TreeManager command. A null indicates using existing variables.

Returns

Returns true if TreeManager was invoked successfully.

errno

Use GetErrno () to check the results of the specific TreeManager command.

Example

// add node
ics.ClearErrno();
inList.removeAll();
inList.setValString("ftcmd", "addchild");
inList.setValString("treename", treeTable);
inList.setValString(Msg.parentnode, node);
inList.setValString(Msg.classType, topicTable);
inList.setValString(Msg.classId, newId);
ics.TreeManager(inList);
ics.GetErrno();

---

ICS.TreeManager

Use this method to execute a TreeManager command.

Syntax

public boolean 
TreeManager(FTValList vIn,
            Object oBatchContext)

Parameters

vIn

List of name/value pairs passed to TreeManager. The ftcmd parameter is required and specifies the specific TreeManager command to execute. Any other parameters depend on the TreeManager command. A null indicates using existing variables.

oBatchContext

A handle for the BatchContext object.

Description

Use this method to execute a TreeManager command. This variant accepts a BatchContext object. The following lists the TreeManager commands that accept BatchContext objects:

• addchild

• addchildren

• deletechild

• deletechildren

Returns

Returns true if TreeManager was invoked successfully.

errno

Use GetErrno () to check the results of the specific TreeManager command.

 

		Home >	Contents >	Index >
	FatWire JAVA Reference Copyright 2005 by FatWire Software All rights reserved.