Interface TranslationObject
-
@ProviderType public interface TranslationObject
The Interface TranslationObject.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description CommentCollection<Comment>
getCommentCollection()
Gets the comment collection.java.lang.String
getId()
Gets confirmation return from the external translation service provider that they have received the TranslationObject for translation.java.lang.String
getMimeType()
Gets the mime type of TranslationObject.java.lang.String
getSourceVersion()
Gets the version name of the source Object.int
getSupportingTranslationObjectsCount()
Deprecated.java.util.Map<java.lang.String,java.util.List<TranslationObject>>
getSupportingTranslationObjectsIterator()
Gets the supporting translation objects list for each relation.java.lang.String
getTitle()
Gets the title of the TranslationObject.java.io.InputStream
getTranslatedObjectInputStream()
Gets the translated Object input stream.TranslationMetadata
getTranslationJobMetadata()
Gets the Translation Job metadatajava.io.InputStream
getTranslationObjectInputStream()
Deprecated.UsegetTranslationObjectXMLInputStream()
instead.java.io.InputStream
getTranslationObjectJSONInputStream()
Gets JSON input stream for the Translation Object to be translated.java.util.zip.ZipInputStream
getTranslationObjectPreview()
Gets a zip input stream containing the preview of Translation Object.java.lang.String
getTranslationObjectSourcePath()
Gets the path to the source Translation Object.java.lang.String
getTranslationObjectTargetPath()
Gets the path to the Translation Object being translated.java.io.InputStream
getTranslationObjectXLIFFInputStream(java.lang.String xliffVersion)
Gets XLIFF input stream for the Translation Object to be translated.java.io.InputStream
getTranslationObjectXMLInputStream()
Gets XML input stream for the Translation Object to be translated.
-
-
-
Method Detail
-
getTitle
java.lang.String getTitle()
Gets the title of the TranslationObject. Title is auto-populated from TranslationObject.- Returns:
- the title
-
getTranslationObjectTargetPath
java.lang.String getTranslationObjectTargetPath()
Gets the path to the Translation Object being translated. The path returned is to where the target Translation Object is stored in AEM CRX de. The path is derived by coping that of the the source Translation Object.- Returns:
- the content url
-
getTranslationObjectSourcePath
java.lang.String getTranslationObjectSourcePath()
Gets the path to the source Translation Object. The path returned is to the where the source Translation Object is stored in AEM CRX de.- Returns:
- the source content url
-
getSourceVersion
java.lang.String getSourceVersion()
Gets the version name of the source Object. If this name is null, then latest version of source content is used.- Returns:
- the version name
-
getMimeType
java.lang.String getMimeType()
Gets the mime type of TranslationObject.- Returns:
- the mime type
-
getId
java.lang.String getId()
Gets confirmation return from the external translation service provider that they have received the TranslationObject for translation. Translation service provider returns a unique TranslationObjectId.- Returns:
- Translation Object Id
-
getCommentCollection
CommentCollection<Comment> getCommentCollection()
Gets the comment collection. This returns all the comments added to the TranslationObject.- Returns:
- the comment Collection
-
getSupportingTranslationObjectsIterator
java.util.Map<java.lang.String,java.util.List<TranslationObject>> getSupportingTranslationObjectsIterator() throws TranslationException
Gets the supporting translation objects list for each relation. Each TranslationObject can have a list of supporting translation objects which add reference to the TranslationObject.- Returns:
- the Map of supporting translation objects list, key contains the relation ship name like source, variant, reference and value of that key is List of TranslationObject
- Throws:
TranslationException
-
getSupportingTranslationObjectsCount
@Deprecated int getSupportingTranslationObjectsCount() throws TranslationException
Deprecated.Gets the supporting translation objects count.- Returns:
- the supporting translation objects count
- Throws:
TranslationException
-
getTranslationJobMetadata
TranslationMetadata getTranslationJobMetadata()
Gets the Translation Job metadata- Returns:
- the Translation Job metadata
-
getTranslationObjectInputStream
@Deprecated java.io.InputStream getTranslationObjectInputStream() throws TranslationException
Deprecated.UsegetTranslationObjectXMLInputStream()
instead. Gets XML input stream for the Translation Object to be translated.- Returns:
- the translation Object input stream
- Throws:
TranslationException
- the translation exception
-
getTranslationObjectXMLInputStream
java.io.InputStream getTranslationObjectXMLInputStream() throws TranslationException
Gets XML input stream for the Translation Object to be translated.- Returns:
- The translation Object XML input stream
- Throws:
TranslationException
- the translation exception
-
getTranslationObjectXLIFFInputStream
java.io.InputStream getTranslationObjectXLIFFInputStream(java.lang.String xliffVersion) throws TranslationException
Gets XLIFF input stream for the Translation Object to be translated.- Parameters:
xliffVersion
- Requested version of XLIFF- Returns:
- The translation Object XLIFF input stream
- Throws:
TranslationException
- the translation exception
-
getTranslationObjectJSONInputStream
java.io.InputStream getTranslationObjectJSONInputStream() throws TranslationException
Gets JSON input stream for the Translation Object to be translated.- Returns:
- The translation Object JSON input stream
- Throws:
TranslationException
- the translation exception
-
getTranslatedObjectInputStream
java.io.InputStream getTranslatedObjectInputStream()
Gets the translated Object input stream. Returns null in case TranslationObject was not translated.- Returns:
- the translated Object input stream
-
getTranslationObjectPreview
java.util.zip.ZipInputStream getTranslationObjectPreview()
Gets a zip input stream containing the preview of Translation Object. This zip contains all the files required for offline preview of the translation object.- Returns:
- Zip input stream, containing the preview of Translation Object.
-
-