com.nesstar.api
Interface VariableGroup

All Superinterfaces:

ComplexDdiElement, DdiElement, NesstarBankObject, NesstarObject

public interface VariableGroup
extends ComplexDdiElement

A variable group in a Nesstar study. The purpose of variable groups is to organise variables. As of DDI v2.1 a variable may belong to more than one variable group.

Since:

0.1

Method Summary

DdiList<VariableGroup>	getVariableGroups() Returns all subgroups directly contained in this variable group.
DdiList<Variable>	getVariables() Returns all variables directly contained in this variable group.

Methods inherited from interface com.nesstar.api.ComplexDdiElement

getElement

Methods inherited from interface com.nesstar.api.NesstarObject

getId, getLabel, getTimeStamp, reload, toURI

Method Detail

getVariables

DdiList<Variable> getVariables()
                               throws NotAuthorizedException,
                                      IOException

Returns all variables directly contained in this variable group.

Returns:

A NesstarList.

Throws:

NotAuthorizedException - If access was denied by the Nesstar server.

IOException - If there was an error while communicating with the server.

getVariableGroups

DdiList<VariableGroup> getVariableGroups()
                                         throws NotAuthorizedException,
                                                IOException

Returns all subgroups directly contained in this variable group.

Returns:

A NesstarList.

Throws:

NotAuthorizedException - If access was denied by the Nesstar server.

IOException - If there was an error while communicating with the server.