com.ibm.websphere.wim.model
Interface HierarchyControl

All Superinterfaces:
Control, PropertyControl, SearchControl
All Known Subinterfaces:
AncestorControl, DescendantControl, GroupControl, GroupMemberControl, GroupMembershipControl

public interface HierarchyControl
extends SearchControl

A representation of the model object 'Hierarchy Control'.

The following features are supported:

See Also:
ModelPackage.getHierarchyControl()
Model:
Generated:

Method Summary
 int getLevel()
          Returns the value of the 'Level' attribute.
 boolean isSetLevel()
          Returns whether the value of the 'Level' attribute is set.
 boolean isSetTreeView()
          Returns whether the value of the 'Tree View' attribute is set.
 boolean isTreeView()
          Returns the value of the 'Tree View' attribute.
 void setLevel(int value)
          Sets the value of the 'Level' attribute.
 void setTreeView(boolean value)
          Sets the value of the 'Tree View' attribute.
 void unsetLevel()
          Unsets the value of the 'Level' attribute.
 void unsetTreeView()
          Unsets the value of the 'Tree View' attribute.
 
Methods inherited from interface com.ibm.websphere.wim.model.SearchControl
getCountLimit, getExpression, getSearchBases, getSearchLimit, getTimeLimit, isReturnSubType, isSetCountLimit, isSetReturnSubType, isSetSearchLimit, isSetTimeLimit, setCountLimit, setExpression, setReturnSubType, setSearchLimit, setTimeLimit, unsetCountLimit, unsetReturnSubType, unsetSearchLimit, unsetTimeLimit
 
Methods inherited from interface com.ibm.websphere.wim.model.PropertyControl
getContextProperties, getProperties
 

Method Detail

getLevel

int getLevel()
Returns the value of the 'Level' attribute. The default value is "1".

Level has different meaning in different contexts. For example, in DescendantControl, it indicates the level of descendants. In GroupMembershipControl, it indicates level of nested groups.
Level=1 means immediate ancestor(parent)/descendant(children)/group/member.
Level=0 means all nested ancestors(parents)/descendants(children)/group/members.
Level=any positive integer means specified level of ancestors(parents)/descendants(children).

See Also:
isSetLevel(), unsetLevel(), setLevel(int), ModelPackage.getHierarchyControl_Level()
Model:
default="1" unique="false" unsettable="true" dataType="org.eclipse.emf.ecore.xml.type.Int"
Generated:
Return:
the value of the 'Level' attribute.

setLevel

void setLevel(int value)
Sets the value of the 'Level' attribute.

Parameters:
value - the new value of the 'Level' attribute.
See Also:
isSetLevel(), unsetLevel(), getLevel()
Generated:

unsetLevel

void unsetLevel()
Unsets the value of the 'Level' attribute.

See Also:
isSetLevel(), getLevel(), setLevel(int)
Generated:

isSetLevel

boolean isSetLevel()
Returns whether the value of the 'Level' attribute is set.

See Also:
unsetLevel(), getLevel(), setLevel(int)
Generated:
Return:
whether the value of the 'Level' attribute is set.

isTreeView

boolean isTreeView()
Returns the value of the 'Tree View' attribute. The default value is "false".

If tree view is false, the dataobjects are returned in as flat list. If it is true then the descendants/groups/members are returned in a tree structure. The tree view is currently not supported.

See Also:
isSetTreeView(), unsetTreeView(), setTreeView(boolean), ModelPackage.getHierarchyControl_TreeView()
Model:
default="false" unique="false" unsettable="true" dataType="org.eclipse.emf.ecore.xml.type.Boolean"
Generated:
Return:
the value of the 'Tree View' attribute.

setTreeView

void setTreeView(boolean value)
Sets the value of the 'Tree View' attribute.

Parameters:
value - the new value of the 'Tree View' attribute.
See Also:
isSetTreeView(), unsetTreeView(), isTreeView()
Generated:

unsetTreeView

void unsetTreeView()
Unsets the value of the 'Tree View' attribute.

See Also:
isSetTreeView(), isTreeView(), setTreeView(boolean)
Generated:

isSetTreeView

boolean isSetTreeView()
Returns whether the value of the 'Tree View' attribute is set.

See Also:
unsetTreeView(), isTreeView(), setTreeView(boolean)
Generated:
Return:
whether the value of the 'Tree View' attribute is set.