com.crystaldecisions.sdk.occa.report.data
Interface ITotallerNode

All Superinterfaces:
IClone
All Known Implementing Classes:
TotallerNode

public interface ITotallerNode
extends IClone

This interface defines a node from the totaller tree. A totaller node contains the records for a particular group in the report. Since groups may contain groups, a node may contains child nodes: the getChildren() method is used for this purpose.


Method Summary
 TotallerNodes getChildren()
           Returns the node's subnodes.
 int getFirstRecordKey()
           Returns the key from the first record that the node contains.
 IGroupPath getGroupPath()
           Returns the path of the node in the totaller tree.
 java.lang.String getName()
           Returns the name of the node.
 TotallerNodeOptions getOptions()
           Returns the options for the totaller node.
 int getRecordCount()
           Returns the number of records that the node contains.
 void setChildren(TotallerNodes newVal)
           Sets the node's subnodes.
 void setFirstRecordKey(int newVal)
           Sets the key from the first record that the node contains.
 void setGroupPath(IGroupPath newVal)
           Sets the path of the node in the totaller tree.
 void setName(java.lang.String name)
           Sets the name of the node.
 void setOptions(TotallerNodeOptions newVal)
           Sets the options for the totaller node.
 void setRecordCount(int newVal)
           Sets the number of records that the node contains.
 

Method Detail

getChildren

TotallerNodes getChildren()

Returns the node's subnodes.

Returns:
A TotallerNodes object containing the node's subnodes.

getFirstRecordKey

int getFirstRecordKey()

Returns the key from the first record that the node contains.

Returns:
An int that specifies the key from the first record that the node contains.

getGroupPath

IGroupPath getGroupPath()

Returns the path of the node in the totaller tree.

Returns:
An IGroupPath object containing the path of the node in the totaller tree.

getName

java.lang.String getName()

Returns the name of the node. This is equivalent to the group's name.

Returns:
A String containing the name of the node.

getOptions

TotallerNodeOptions getOptions()

Returns the options for the totaller node.

Returns:
A TotallerNodeOptions object containing the options for the totaller node.

getRecordCount

int getRecordCount()

Returns the number of records that the node contains.

Returns:
An int that specifies the number of records that the node contains.

setChildren

void setChildren(TotallerNodes newVal)

Sets the node's subnodes.

Parameters:
newVal - A TotallerNodes object containing the node's subnodes.

setFirstRecordKey

void setFirstRecordKey(int newVal)

Sets the key from the first record that the node contains.

Parameters:
newVal - An int that specifies the key from the first record that the node contains.

setGroupPath

void setGroupPath(IGroupPath newVal)

Sets the path of the node in the totaller tree.

Parameters:
newVal - An IGroupPath object containing the path of the node in the totaller tree.

setName

void setName(java.lang.String name)

Sets the name of the node. This is equivalent to the group's name.

Parameters:
name - A String containing the name of the node.

setOptions

void setOptions(TotallerNodeOptions newVal)

Sets the options for the totaller node.

Parameters:
newVal - A TotallerNodeOptions object containing the options for the totaller node.

setRecordCount

void setRecordCount(int newVal)

Sets the number of records that the node contains.

Parameters:
newVal - An int that specifies the number of records that the node contains.