com.ibm.ftt.properties
Interface ICategoryInstance

All Known Implementing Classes:
AbstractCategoryInstance

public interface ICategoryInstance

A category instance holds property values for a particular category. Each instance has a name that is unique among all of the instances of a category.


Field Summary
static String COPY_RIGHT
           
 
Method Summary
 ICategory getCategory()
          Returns the category that defines this instance.
 String getName()
          The name of this instance.
 List getProperties()
          Returns all of the properties for this category instance.
 List getPropertyGroups()
          Returns the property groups this category instance belongs to.
 String getValue(String name)
          Convenience method for returning the value of a property belonging to this category instance.
 void setName(String name)
          Sets the name of this instance.
 void setValue(String name, String value)
          Sets the value of a property belonging to the category instance.
 

Field Detail

COPY_RIGHT

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

getName

String getName()
The name of this instance. The name is unique among all of the instances of a category.

Returns:
The instance name.

setName

void setName(String name)
             throws DuplicateInstanceException
Sets the name of this instance.

Parameters:
name - The instance name. The name must be unique among all of the instances of a category.

Throws:
DuplicateInstanceException - If the name is the name of an existing instance.

getCategory

ICategory getCategory()
Returns the category that defines this instance.

Returns:
The category that defines this instance.

getPropertyGroups

List getPropertyGroups()
Returns the property groups this category instance belongs to.

Returns:
The property groups this category instance belongs to. The returned list is an unmodifiable list.

setValue

void setValue(String name,
              String value)
              throws UnregisteredPropertyException
Sets the value of a property belonging to the category instance.

Parameters:
name - The name of the property
value - The value for the property.

Throws:
UnregisteredPropertyException - If the given name is not the name of a property belonging to this instance.

getValue

String getValue(String name)
                throws UnregisteredPropertyException
Convenience method for returning the value of a property belonging to this category instance. This method returns null if there is no property value for the given property.

Parameters:
name - The name of the property

Returns:
The value of the property.

Throws:
UnregisteredPropertyException - If the name given name is not the name of a property belonging to this instance.

getProperties

List getProperties()
Returns all of the properties for this category instance.

Returns:
The properties belonging to this category instance. The returned list is unmodifiable.