|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
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 |
|---|
static final String COPY_RIGHT
| Method Detail |
|---|
String getName()
void setName(String name)
throws DuplicatePropertyGroupException
name - Must be unique among the property groups in a property group container.
DuplicatePropertyGroupException - If the given name is the name of a
property group in the property group container.String getDescription()
void setDescription(String description)
description - The description can be used to identify the purpose for a
property group.IPropertyGroupContainer getPropertyGroupContainer()
List getCategoryInstances()
void addCategoryInstance(ICategoryInstance instance)
throws DuplicateInstanceException
instance - The category instance to add.
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.void deleteCategoryInstance(ICategoryInstance instance)
instance - The category instance to remove.
IPropertyGroup copy(String name)
throws UnsupportedOperationException,
DuplicatePropertyGroupException
name - The name of the copy of the property group
UnsupportedOperationException
DuplicatePropertyGroupException
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||