com.ibm.ftt.properties
Interface IPropertyGroup

All Known Implementing Classes:
AbstractPropertyGroup

public interface IPropertyGroup

A property group is a collection of category instances that has a name, and an optional description. The category instances contain the values of the properties in the property group. You create a property group by calling the #createPropertyGroup() method in the IPropertyGroupContainer interface.

Each property group is required to be in a property group container and must have a name that is unique among the property groups belonging to a property group container.


Field Summary
static String COPY_RIGHT
           
 
Method Summary
 void addCategoryInstance(ICategoryInstance instance)
          Adds the category instance to the property group.
 IPropertyGroup copy(String name)
          Makes a copy of the property group and returns it.
 void deleteCategoryInstance(ICategoryInstance instance)
          Removes the category instance from the property group.
 List getCategoryInstances()
          Returns the category instances for the property group.
 String getDescription()
          Returns the description for the property group; it may be null.
 String getName()
          Returns the property group name.
 IPropertyGroupContainer getPropertyGroupContainer()
          Returns the property group container the property group belongs to.
 void setDescription(String description)
          Sets the description for the property group.
 void setName(String name)
          The name must be unique among the property groups in a property group container.
 

Field Detail

COPY_RIGHT

static final String COPY_RIGHT
See Also:
Constant Field Values
Method Detail

getName

String getName()
Returns the property group name.

Returns:
The name of the property group.

setName

void setName(String name)
             throws DuplicatePropertyGroupException
The name must be unique among the property groups in a property group container. Use this method to rename a property group.

Parameters:
name - Must be unique among the property groups in a property group container.

Throws:
DuplicatePropertyGroupException - If the given name is the name of a property group in the property group container.

getDescription

String getDescription()
Returns the description for the property group; it may be null.

Returns:
The description for the property group.

setDescription

void setDescription(String description)
Sets the description for the property group.

Parameters:
description - The description can be used to identify the purpose for a property group.

getPropertyGroupContainer

IPropertyGroupContainer getPropertyGroupContainer()
Returns the property group container the property group belongs to.

Returns:
The property group container this property group belongs to.

getCategoryInstances

List getCategoryInstances()
Returns the category instances for the property group.

Returns:
The category instances for the property group. The returned list is an unmodifiable list.

addCategoryInstance

void addCategoryInstance(ICategoryInstance instance)
                         throws DuplicateInstanceException
Adds the category instance to the property group.

Parameters:
instance - The category instance to add.

Throws:
DuplicateInstanceException - If the instance already belongs to the property group, or if adding the instance violates a constraint for the particular implementation of this property group.

deleteCategoryInstance

void deleteCategoryInstance(ICategoryInstance instance)
Removes the category instance from the property group.

Parameters:
instance - The category instance to remove.

copy

IPropertyGroup copy(String name)
                    throws UnsupportedOperationException,
                           DuplicatePropertyGroupException
Makes a copy of the property group and returns it. If instances is true, the category instances are copied and the copies are used in the returned property group. If instances is false, the category instances are not copied; the existing category instances are used in the returned property group.

Parameters:
name - The name of the copy of the property group

Returns:
The copy of the property group
Throws:
UnsupportedOperationException
DuplicatePropertyGroupException