tv.amwa.maj.iface
Interface MetaDefinition

All Known Subinterfaces:

ClassDefinition, PropertyDefinition, TypeDefinition, TypeDefinitionCharacter, TypeDefinitionEnumeration, TypeDefinitionExtendibleEnumeration, TypeDefinitionFixedArray, TypeDefinitionIndirect, TypeDefinitionInteger, TypeDefinitionObjectReference, TypeDefinitionOpaque, TypeDefinitionRecord, TypeDefinitionRename, TypeDefinitionSet, TypeDefinitionStream, TypeDefinitionString, TypeDefinitionStrongObjectReference, TypeDefinitionVariableArray, TypeDefinitionWeakObjectReference

All Known Implementing Classes:

ClassDefinition, MetaDefinition, PropertyDefinition, TypeDefinition, TypeDefinitionCharacter, TypeDefinitionEnumeration, TypeDefinitionExtendibleEnumeration, TypeDefinitionFixedArray, TypeDefinitionIndirect, TypeDefinitionInteger, TypeDefinitionObjectReference, TypeDefinitionObjectReference.TypeDefinitionObjectReferenceUnresolved, TypeDefinitionOpaque, TypeDefinitionRecord, TypeDefinitionRename, TypeDefinitionSet, TypeDefinitionStream, TypeDefinitionString, TypeDefinitionStrongObjectReference, TypeDefinitionVariableArray, TypeDefinitionWeakObjectReference

public interface MetaDefinition

Specifies the definition of a class, type, or property in an AAF file.

Author:

Richard Cartwright

Method Summary

AUID	getAUID() Returns the identification for this meta definition.
String	getDescription() Returns the description of this meta definition.
String	getName() Returns the name of this meta definition.
void	setDescription(String description) Sets the description of this meta definition.
void	setName(String name) Sets the name of this meta definition.

Method Detail

getAUID

AUID getAUID()

Returns the identification for this meta definition.

Returns:

Identification for this meta definition.

setName

void setName(@AAFString
             String name)
             throws NullPointerException

Sets the name of this meta definition.

Parameters:

name - Name to set for this meta definition.

Throws:

NullPointerException - The given meta definition name is null.

getName

@AAFString
String getName()

Returns the name of this meta definition.

Returns:

Name of the meta definition.

setDescription

void setDescription(@AAFString
                    String description)

Sets the description of this meta definition. Set this optional property to null to omit it.

Parameters:

description - Description of this meta definition.

getDescription

@AAFString
String getDescription()
                      throws PropertyNotPresentException

Returns the description of this meta definition. This is an optional property.

Returns:

Description of this meta definition.

Throws:

PropertyNotPresentException - The optional description property is not present in this meta definition.