tv.amwa.maj.iface
Interface Identification

All Superinterfaces:

InterchangeObject

All Known Implementing Classes:

Identification

public interface Identification
extends InterchangeObject

Specifies identity information about the application that created or modified a file.

If a file was opened for modification by many applications in its lifetime, then there will be multiple identification objects. These are kept in an ordered list, with the first entry being the file creator, and the last entry being the last application to modify the file. The list is stored in the header of a file and accessed with Header.getIdentifications().

An identification is useful for technical support when diagnosing problems with AAF files, as it tells which applications and versions of applications have touched the file. If a file has been modified by multiple applications, then the date and product id properties can be used to tell which changes to the file were made by a particular application.

Author:

Richard Cartwright

See Also:

makeIdentification(), Header.getLastIdentification()

Method Summary

String	getCompanyName() Returns the company name property of this identification, which specifies the name of the company or organization that created the application.
TimeStamp	getDate() Returns the time stamp property of this identification.
AUID	getGenerationAUID() Returns the generation identifier of this AAF file, which is an AUID that was generated at the time this identification was created.
String	getPlatform() Returns the platform property of this identification, which specifies the toolkit and the platform on which the application is running, e.g.
AUID	getProductID() Returns the product id of this identification, which uniquely identifies the application.
String	getProductName() Returns the product name of this identification, which specifies the name of the application.
ProductVersion	getProductVersion() Gets the product version property associated with this identification, which specifies the version number of the application.
String	getProductVersionString() Returns the product version string of this identification, which specifies the version number of the application in string form.
ProductVersion	getRefImplVersion() Returns the reference implementation which created this identification object.
void	setProductVersion(ProductVersion version) Set the product version property of this identification, which specifies the version number of the application.

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

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

Method Detail

getCompanyName

@AAFString
String getCompanyName()

Returns the company name property of this identification, which specifies the name of the company or organization that created the application.

Returns:

Company name of this identification.

getProductName

@AAFString
String getProductName()

Returns the product name of this identification, which specifies the name of the application.

Returns:

Product name of this identification.

getProductVersionString

@AAFString
String getProductVersionString()

Returns the product version string of this identification, which specifies the version number of the application in string form.

Returns:

Product version string of this identification.

getProductVersion

ProductVersion getProductVersion()
                                 throws PropertyNotPresentException

Gets the product version property associated with this identification, which specifies the version number of the application. This is an optional property.

Returns:

Product version property associated with this identification.

Throws:

PropertyNotPresentException - The optional product version property is not present in this identification.

setProductVersion

void setProductVersion(ProductVersion version)

Set the product version property of this identification, which specifies the version number of the application. Set this optional property to null to omit it.

Parameters:

version - Product version to set for this identification.

getProductID

AUID getProductID()

Returns the product id of this identification, which uniquely identifies the application.

Returns:

Product id of this identification.

getDate

TimeStamp getDate()

Returns the time stamp property of this identification. The date-time stamp recorded in this object corresponds to the time that this file was created or modified on the occasion that this identification was added to the file.

Returns:

Time stamp of this identification.

See Also:

Header.appendIdentification(Identification)

getRefImplVersion

ProductVersion getRefImplVersion()

Returns the reference implementation which created this identification object.

Returns:

Reference implementation version.

getPlatform

@AAFString
String getPlatform()
                   throws PropertyNotPresentException

Returns the platform property of this identification, which specifies the toolkit and the platform on which the application is running, e.g. "MAJ API". This is an optional property.

This information is provided only to allow diagnostic printing of platform information to be read by humans. The format of the strings is not guaranteed to remain the same for a given platform.

Returns:

Platform property of this identification.

Throws:

PropertyNotPresentException - The optional platform property is not present in this identification.

getGenerationAUID

AUID getGenerationAUID()

Returns the generation identifier of this AAF file, which is an AUID that was generated at the time this identification was created. If a file was opened for modification by many applications in its lifetime, then there will be multiple Identification objects.

Note that this is a read-only property automatically generated by the implementation.

Specified by:

getGenerationAUID in interface InterchangeObject

Returns:

Unique generation AUID of this identification.

See Also:

InterchangeObject.getGeneration(), getGenerationAUID()