tv.amwa.maj.iface
Interface TextLocator

All Superinterfaces:

InterchangeObject, Locator

All Known Implementing Classes:

TextLocator

public interface TextLocator
extends Locator

Specifies information to help find a file containing the essence or to help find the physical media. A text locator is not intended for applications to use without user intervention.

Author:

Richard Cartwright

See Also:

makeTextLocator()

Method Summary

String	getName() Returns the name of the text locator, which provides a text string containing information to help find the file containing the essence or the physical media.
void	setName(String name) Sets the name of the text locator, which provides a text string containing information to help find the file containing the essence or the physical media.

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

getPath, setPath

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 name of the text locator, which provides a text string containing information to help find the file containing the essence or the physical media.

Parameters:

name - Name property of the text locator.

Throws:

NullPointerException - The given name is null.

See Also:

Locator.setPath(String)

getName

@AAFString
String getName()

Returns the name of the text locator, which provides a text string containing information to help find the file containing the essence or the physical media.

Returns:

Name property of the text locator.

See Also:

Locator.getPath()