|
Media Authoring with Java API |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DefinitionObject
Specifies a definition to be referenced.
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 |
---|
void setName(@AAFString String name) throws NullPointerException
Sets the display name of this definition.
name
- The display name of the item being defined.
NullPointerException
- The given display name is null
.@AAFString String getName()
Returns the display name of this definition.
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.
description
- An explanation of the use of the item being defined.@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.
PropertyNotPresentException
- The optional property is not set
for this definition.AUID getAUID()
Returns the identifier of this definition, which specifies the unique identifier for the item being defined.
|
Media Authoring with Java API |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |