tv.amwa.maj.iface
Interface TaggedValueDefinition

All Superinterfaces:

DefinitionObject, InterchangeObject

All Known Implementing Classes:

TaggedValueDefinition

public interface TaggedValueDefinition
extends DefinitionObject

Specifies the documentation of tagged values used in a file. The name of the definition is the same as the name of the tagged value it documents. The description of the definition provides the documentation.

The extended optional parent properties property is available to assist applications but is not a built-in property that is persistent in files.

Author:

Richard Cartwright

See Also:

makeTaggedValueDefinition(), Dictionary.getTaggedValueDefinitions(), DefinitionObject.setDescription(String)

Method Summary

void	addParentProperty(PropertyDefinition parentProperty) Add a parent property to the list of parent properties of this tagged value definition, which specify which properties specify tagged values of this kind.
int	countParentProperties() Returns the number of parent properties of this tagged value definition, which specify which properties specify tagged values of this kind.
Set<? extends PropertyDefinition>	getParentProperties() Returns the set of parent property definitions of this tagged value definition, which specify which properties specify tagged values of this kind.
void	removeParentProperty(PropertyDefinition parentProperty) Removes the given parent property from the list of parent properties of this tagged value definition, which specify which properties specify tagged values of this type.

Methods inherited from interface tv.amwa.maj.iface.DefinitionObject

getAUID, getDescription, getName, setDescription, setName

Methods inherited from interface tv.amwa.maj.iface.InterchangeObject

countProperties, createOptionalPropertyValue, disableGenerationTracking, enableGenerationTracking, getDefinition, getGeneration, getGenerationAUID, getProperties, getPropertyValue, isGenerationTracked, isPropertyPresent, omitOpionalProperty, setPropertyValue

Method Detail

addParentProperty

void addParentProperty(PropertyDefinition parentProperty)
                       throws NullPointerException

Add a parent property to the list of parent properties of this tagged value definition, which specify which properties specify tagged values of this kind. For example, mob user comments or component attributes.

This is an extended optional property. If this property is omitted, a successful call to this method will make it present.

Parameters:

parentProperty - Parent property to add to the list of parent properties of the tagged value definition.

Throws:

NullPointerException - The given parent property is null.

getParentProperties

Set<? extends PropertyDefinition> getParentProperties()
                                                      throws PropertyNotPresentException

Returns the set of parent property definitions of this tagged value definition, which specify which properties specify tagged values of this kind. For example, mob user comments or component attributes. This is an extended optional property.

Returns:

Shallow copy of the set of parent property definitions of this tagged value definition.

Throws:

PropertyNotPresentException - The optional parent properties property is not present in this tagged value definition.

countParentProperties

@UInt32
int countParentProperties()
                          throws PropertyNotPresentException

Returns the number of parent properties of this tagged value definition, which specify which properties specify tagged values of this kind. For example, mob user comments or component attributes. This is an extended optional property.

Returns:

Number of parent properties of this tagged value definition.

Throws:

PropertyNotPresentException - The optional parent properties property is not present in this tagged value definition.

removeParentProperty

void removeParentProperty(PropertyDefinition parentProperty)
                          throws NullPointerException,
                                 NoMoreObjectsException,
                                 PropertyNotPresentException

Removes the given parent property from the list of parent properties of this tagged value definition, which specify which properties specify tagged values of this type. For example, mob user comments or component attributes. This is an extended optional property. Removing the last parent property from the set will omit the property.

Parameters:

parentProperty - Property definition to remove from the list of parent properties of this tagged value definition.

Throws:

NullPointerException - The given parent property to remove is not present in the set of parent properties of this tagged value definition.

NoMoreObjectsException - The property definition is not in the set of parent property definitions of this tagged value definition.

PropertyNotPresentException - The optional parent properties property is not present in this tagged value definition.