Package com.ptc.tml.collection

Class TranslationCollection

java.lang.Object

com.ptc.tml.collection.TranslationCollection

Direct Known Subclasses:

TranslationPivotCollection, TranslationRootCollection

public abstract class TranslationCollection
extends Object

Supported API: true

Method Summary

Modifier and Type	Method	Description
static TranslationCollection	fromOidString(String oidString)	Converts an oid string to a TranslationCollection
WTContainer	getContainer()	Supported API: true Gets the context container from the Container Oid attribute
WTContainerRef	getContainerRef()	Supported API: true Gets the context container ref from the Container Oid attribute
String	getName()	Supported API: true Get the name of the collection
String	getOutputDirectory()	Supported API: true Get the value of the collection's Output Directory attribute
abstract String	getSourceLanguage()	Supported API: true Get the source language for a collection, either the authoring language or the pivot language, depending on the type of collection
String	getSourceOid()	Supported API: true Get the value of the collection's Source Oid attribute
String	getTargetLanguage()	Supported API: true Get the value of the collection's Target Language attribute
String	getUserName()	Supported API: true Get the value of the collection's User Name attribute

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getName

public String getName()

Supported API: true Get the name of the collection

getSourceLanguage

public abstract String getSourceLanguage()
                                  throws TranslationException

Supported API: true Get the source language for a collection, either the authoring language or the pivot language, depending on the type of collection

Throws:

TranslationException

getTargetLanguage

public String getTargetLanguage()
                         throws TranslationException

Supported API: true Get the value of the collection's Target Language attribute

Throws:

TranslationException

getSourceOid

public String getSourceOid()
                    throws TranslationException

Supported API: true Get the value of the collection's Source Oid attribute

Throws:

TranslationException

getOutputDirectory

public String getOutputDirectory()
                          throws TranslationException

Supported API: true Get the value of the collection's Output Directory attribute

Throws:

TranslationException

getUserName

public String getUserName()
                   throws TranslationException

Supported API: true Get the value of the collection's User Name attribute

Throws:

TranslationException

getContainerRef

public WTContainerRef getContainerRef()
                               throws TranslationException

Supported API: true Gets the context container ref from the Container Oid attribute

Throws:

TranslationException

getContainer

public WTContainer getContainer()
                         throws TranslationException

Supported API: true Gets the context container from the Container Oid attribute

Throws:

TranslationException

fromOidString

public static TranslationCollection fromOidString(String oidString)
                                           throws TranslationException

Converts an oid string to a TranslationCollection

Parameters:

oidString -

Returns:

Throws:

TranslationException -

Supported API: true