Package com.idmedia.translationstudio.api.connector.dao

Class TransferedFile

java.lang.Object

com.idmedia.translationstudio.api.connector.dao.TransferedFile

All Implemented Interfaces:

IRegisteredFile, ITransferedFile, ITransferedFileConnectorProject, ITransferedFileMeta, ITransferedFileQueueable, ITransferedFileTmsMeta

public class TransferedFile
extends Object
implements ITransferedFile

Author:

I-D Media AG

Constructor Summary

Constructors

Constructor	Description
TransferedFile(String sTmsProjectId, String sTmsFileId, long lCmsProjectId, @NotNull String sSourceLanguage, @NotNull String sTargetLanguage, @NotNull String sTmsProjectDisplayName)
TransferedFile(String sTmsProjectId, String sTmsFileId, long lCmsProjectId, @NotNull String sSourceLanguage, @NotNull String sTargetLanguage, @NotNull String sTmsProjectDisplayName, @NotNull String sTmsProjectFileName, @NotNull String sCmsPageNames)
TransferedFile(String sTmsProjectId, String sTmsFileId, long lCmsProjectId, @NotNull String sSourceLanguage, @NotNull String sTargetLanguage, @NotNull String sTmsProjectDisplayName, @NotNull String sTmsProjectFileName, @NotNull String sCmsPageNames, @Nullable Date pDeadline)

Method Summary

Modifier and Type	Method	Description
void	addProperty(@NotNull String sKey, @NotNull String sValue)	Add a custom property
void	addTranslatableFile(ITranslatableFile file)
void	addTranslatableFile(List<ITranslatableFile> files)
long	getCmsProjectId()	Get the CMS project id
String	getConnectorName()
@Nullable Date	getDeadline()	Get the project's deadline
@NotNull String	getIdentifier()	Get File identifier
@NotNull String	getPageNameList()	Get the name of the CMS pages that are stored here
@NotNull String	getProperty(@NotNull String sKey)	Get a custom property
@NotNull String	getSourceLangage()	Source language code
@NotNull String	getTargetLangage()	Target language code
@NotNull String	getTmsProjectDisplayName()	Get the name of the TMS project which holds this file
@NotNull String	getTmsProjectFileName()	Get the name of the TMS project which holds this file
@NotNull String	getTmsProjectId()	Get the target TMS project
String	getTmsProjectIdAndFilId()
@NotNull List<ITranslatableFile>	getTranslatableFiles()
boolean	isQueued()	THis file is part of a queued project
void	setConnectorName(@NotNull String sConnectorName)
void	setIsQueued(boolean b)

Methods inherited from class java.lang.Object

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

Constructor Details

TransferedFile

public TransferedFile(String sTmsProjectId,
 String sTmsFileId,
 long lCmsProjectId,
 @NotNull
 @NotNull String sSourceLanguage,
 @NotNull
 @NotNull String sTargetLanguage,
 @NotNull
 @NotNull String sTmsProjectDisplayName,
 @NotNull
 @NotNull String sTmsProjectFileName,
 @NotNull
 @NotNull String sCmsPageNames,
 @Nullable
 @Nullable Date pDeadline)

TransferedFile

public TransferedFile(String sTmsProjectId,
 String sTmsFileId,
 long lCmsProjectId,
 @NotNull
 @NotNull String sSourceLanguage,
 @NotNull
 @NotNull String sTargetLanguage,
 @NotNull
 @NotNull String sTmsProjectDisplayName)

TransferedFile

public TransferedFile(String sTmsProjectId,
 String sTmsFileId,
 long lCmsProjectId,
 @NotNull
 @NotNull String sSourceLanguage,
 @NotNull
 @NotNull String sTargetLanguage,
 @NotNull
 @NotNull String sTmsProjectDisplayName,
 @NotNull
 @NotNull String sTmsProjectFileName,
 @NotNull
 @NotNull String sCmsPageNames)

Method Details

getTmsProjectId

@NotNull
public @NotNull String getTmsProjectId()

Get the target TMS project

Specified by:

getTmsProjectId in interface IRegisteredFile

Returns:

Tms Project to lookup a translatable xml file in the TMS

getIdentifier

@NotNull
public @NotNull String getIdentifier()

Get File identifier

Specified by:

getIdentifier in interface IRegisteredFile

Returns:

Identifier to lookup a translatable xml file in the TMS

getSourceLangage

@NotNull
public @NotNull String getSourceLangage()

Source language code

Specified by:

getSourceLangage in interface ITransferedFileMeta

Returns:

getTargetLangage

@NotNull
public @NotNull String getTargetLangage()

Target language code

Specified by:

getTargetLangage in interface ITransferedFileMeta

Returns:

getCmsProjectId

public long getCmsProjectId()

Get the CMS project id

Specified by:

getCmsProjectId in interface ITransferedFileMeta

Returns:

getTmsProjectDisplayName

@NotNull
public @NotNull String getTmsProjectDisplayName()

Get the name of the TMS project which holds this file

Specified by:

getTmsProjectDisplayName in interface ITransferedFileConnectorProject

Returns:

getPageNameList

@NotNull
public @NotNull String getPageNameList()

Get the name of the CMS pages that are stored here

Specified by:

getPageNameList in interface ITransferedFileConnectorProject

Returns:

getTmsProjectFileName

@NotNull
public @NotNull String getTmsProjectFileName()

Get the name of the TMS project which holds this file

Specified by:

getTmsProjectFileName in interface ITransferedFileConnectorProject

Returns:

getDeadline

@Nullable
public @Nullable Date getDeadline()

Get the project's deadline

Specified by:

getDeadline in interface ITransferedFileConnectorProject

Returns:

addProperty

public void addProperty(@NotNull
 @NotNull String sKey,
 @NotNull
 @NotNull String sValue)

Add a custom property

Specified by:

addProperty in interface ITransferedFileConnectorProject

Parameters:

sKey -

sValue -

getProperty

@NotNull
public @NotNull String getProperty(@NotNull
 @NotNull String sKey)

Get a custom property

Specified by:

getProperty in interface ITransferedFileConnectorProject

Parameters:

sKey -

Returns:

isQueued

public boolean isQueued()

THis file is part of a queued project

Specified by:

isQueued in interface ITransferedFileQueueable

Returns:

setIsQueued

public void setIsQueued(boolean b)

getTmsProjectIdAndFilId

public String getTmsProjectIdAndFilId()

Specified by:

getTmsProjectIdAndFilId in interface ITransferedFileTmsMeta

setConnectorName

public void setConnectorName(@NotNull
 @NotNull String sConnectorName)

addTranslatableFile

public void addTranslatableFile(ITranslatableFile file)

addTranslatableFile

public void addTranslatableFile(List<ITranslatableFile> files)

getTranslatableFiles

@NotNull
public @NotNull List<ITranslatableFile> getTranslatableFiles()

Specified by:

getTranslatableFiles in interface ITransferedFileTmsMeta

getConnectorName

public String getConnectorName()

Specified by:

getConnectorName in interface ITransferedFileTmsMeta