tv.amwa.maj.iface
Interface ContainerDefinition

All Superinterfaces:

DefinitionObject, InterchangeObject

All Known Implementing Classes:

ContainerDefinition

public interface ContainerDefinition
extends DefinitionObject

Specifies a definition for the mechanism used to store essence data. A container can be either a kind of file, such as an AAF file, or it can be another mechanism for storing essence data.

Author:

Richard Cartwright

See Also:

makeContainerDefinition(), ContainerConstant, ContainerDefinition.forName(String), ContainerDefinition.forIdentification(tv.amwa.maj.record.AUID), Dictionary.getContainerDefinitions()

Method Summary

boolean	essenceIsIdentified() Deprecated. Use getEssenceIsIdentified() instead.
boolean	getEssenceIsIdentified() Returns whether the essence of the defined container is identified, which specifies when true that the container uses the mob id to identify the essence data and that the container may contain multiple essence data objects, each identified by a mob id.
void	setEssenceIsIdentified(Boolean essenceIsIdentified) Sets whether the essence of the defined container is identified, which specifies when true that the container uses the mob id to identify the essence data and that the container may contain multiple essence data objects, each identified by a mob id.

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

essenceIsIdentified

@Deprecated
@Bool
boolean essenceIsIdentified()
                            throws PropertyNotPresentException

Deprecated. Use getEssenceIsIdentified() instead.

Returns whether the essence of the defined container is identified, which specifies when true that the container uses the mob id to identify the essence data and that the container may contain multiple essence data objects, each identified by a mob id. This is an optional property.

Returns:

Is the essence identified?

Throws:

PropertyNotPresentException - The optional essence is identified property is not present in the container definition.

getEssenceIsIdentified

@Bool
boolean getEssenceIsIdentified()
                               throws PropertyNotPresentException

Returns whether the essence of the defined container is identified, which specifies when true that the container uses the mob id to identify the essence data and that the container may contain multiple essence data objects, each identified by a mob id. This is an optional property.

Returns:

Is the essence identified?

Throws:

PropertyNotPresentException - The optional essence is identified property is not present in the container definition.

setEssenceIsIdentified

void setEssenceIsIdentified(@Bool
                            Boolean essenceIsIdentified)

Sets whether the essence of the defined container is identified, which specifies when true that the container uses the mob id to identify the essence data and that the container may contain multiple essence data objects, each identified by a mob id. To omit this optional property, set its value to null.

Parameters:

essenceIsIdentified - Is the essence identified?