com.ibm.ftt.properties
Interface ICategory

All Known Implementing Classes:
AbstractCategory

public interface ICategory

A category defines a named collection of properties. All registered categories can be obtained by calling IPropertyGroupManager.getCategories().

A category instance is an object that contains the values of the properties in a category.

See Also:
ICategoryInstance

Field Summary
static String COPY_RIGHT
           
 
Method Summary
 boolean deleteInstance(ICategoryInstance instance)
          Deletes a category instance from this category.
 List<ICategoryInstance> getInstances()
          Returns all of the category instances for this category.
 String getName()
          Returns the name of the category.
 List<IPropertyInfo> getPropertyInformation()
          Returns the property info objects that contain information about the properties registered with the category in the property group manager.
 ICategoryInstance makeInstance()
          Makes an instance of this category.
 

Field Detail

COPY_RIGHT

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

getName

String getName()
Returns the name of the category.

Returns:
The name of the category. The category name is unique among all of the categories registered with a property group manager.

getPropertyInformation

List<IPropertyInfo> getPropertyInformation()
Returns the property info objects that contain information about the properties registered with the category in the property group manager.

Returns:
The list of property info objects for the properties in the category. The returned list is unmodifiable.

makeInstance

ICategoryInstance makeInstance()
Makes an instance of this category.

Returns:
The category instance

deleteInstance

boolean deleteInstance(ICategoryInstance instance)
Deletes a category instance from this category.

Parameters:
The - category instance to delete.
Returns:
true if the instance was deleted; false otherwise.

getInstances

List<ICategoryInstance> getInstances()
Returns all of the category instances for this category.

Returns:
The category instances for this category. The returned list is unmodifiable.