tv.amwa.maj.iface
Interface DefinitionObject

All Superinterfaces:

InterchangeObject

All Known Subinterfaces:

CodecDefinition, ContainerDefinition, DataDefinition, InterpolationDefinition, KLVDataDefinition, OperationDefinition, ParameterDefinition, PluginDefinition, TaggedValueDefinition

All Known Implementing Classes:

CodecDefinition, ContainerDefinition, DataDefinition, DefinitionObject, InterpolationDefinition, KLVDataDefinition, OperationDefinition, ParameterDefinition, PluginDefinition, TaggedValueDefinition

public interface DefinitionObject
extends InterchangeObject

Specifies a definition to be referenced.

Author:

Richard Cartwright

See Also:

Dictionary

Method Summary

AUID	getAUID() Returns the identifier of this definition, which specifies the unique identifier for the item being defined.
String	getDescription() Returns the description of this definition, which provides an explanation of the use of the item being defined.
String	getName() Returns the display name of this definition.
void	setDescription(String description) Sets the description of this definition, which provides an explanation of the use of the item being defined.
void	setName(String name) Sets the display name of this definition.

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

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

Method Detail

setName

void setName(@AAFString
             String name)
             throws NullPointerException

Sets the display name of this definition.

Parameters:

name - The display name of the item being defined.

Throws:

NullPointerException - The given display name is null.

getName

@AAFString
String getName()

Returns the display name of this definition.

Returns:

name The display name of the item being defined.

setDescription

void setDescription(@AAFString
                    String description)

Sets the description of this definition, which provides an explanation of the use of the item being defined. Set this optional property to null to omit it.

Parameters:

description - An explanation of the use of the item being defined.

getDescription

@AAFString
String getDescription()
                      throws PropertyNotPresentException

Returns the description of this definition, which provides an explanation of the use of the item being defined. This is an optional property.

Returns:

An explanation of the use of the item being defined.

Throws:

PropertyNotPresentException - The optional property is not set for this definition.

getAUID

AUID getAUID()

Returns the identifier of this definition, which specifies the unique identifier for the item being defined.

Returns:

The unique identifier for the item being defined.