Package com.idmedia.translationstudio.api.connector

Class TMSFile

java.lang.Object

com.idmedia.translationstudio.api.connector.TMSFile

public class TMSFile
extends Object

This hold basic information about the XML in the TMS

Author:

I-D Media AG

Constructor Summary

Constructors

Constructor	Description
TMSFile(@Nullable String sProjectId, @NotNull String sFileId)	Create instance
TMSFile(@Nullable String sProjectId, @NotNull String sFileId, @NotNull String sTmsProjectName, @NotNull String sTmsFileName, @NotNull String sCmsPageName)	Create instance
TMSFile(@Nullable String sProjectId, @NotNull String sFileId, @NotNull String sTmsProjectName, @NotNull String sTmsFileName, @NotNull String sCmsPageName, @NotNull String sTargetLanguage)	Create instance

Method Summary

Modifier and Type	Method	Description
@NotNull String	getCmsPageName()	Get the associated CMS page name(s)
@NotNull String	getFileId()	Internal File ID as used by the TMS
@NotNull String	getProjectId()	Get the TMS Project of this file
@NotNull String	getTargetLanguage()	Get the target language (if available)
@NotNull String	getTmsFileName()	Get the TMS file name in the project
@NotNull String	getTmsProjectName()	Get the TMS project name
boolean	hasNameInformation()	Check if there is name information available

Methods inherited from class java.lang.Object

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

Constructor Details

TMSFile

public TMSFile(@Nullable
 @Nullable String sProjectId,
 @NotNull
 @NotNull String sFileId)

Create instance

Parameters:

sProjectId - TMS Project Id

sFileId - TMS File Id

TMSFile

public TMSFile(@Nullable
 @Nullable String sProjectId,
 @NotNull
 @NotNull String sFileId,
 @NotNull
 @NotNull String sTmsProjectName,
 @NotNull
 @NotNull String sTmsFileName,
 @NotNull
 @NotNull String sCmsPageName)

Create instance

Parameters:

sProjectId - TMS Project Id

sFileId - TMS File Id

sTmsProjectName - TMS project name

sTmsFileName - TMS project file name

sCmsPageName - CMS page name(s)

TMSFile

public TMSFile(@Nullable
 @Nullable String sProjectId,
 @NotNull
 @NotNull String sFileId,
 @NotNull
 @NotNull String sTmsProjectName,
 @NotNull
 @NotNull String sTmsFileName,
 @NotNull
 @NotNull String sCmsPageName,
 @NotNull
 @NotNull String sTargetLanguage)

Create instance

Parameters:

sProjectId - TMS Project Id

sFileId - TMS File Id

sTmsProjectName - TMS project name

sTmsFileName - TMS project file name

sCmsPageName - CMS page name(s)

sTargetLanguage -

Method Details

hasNameInformation

public boolean hasNameInformation()

Check if there is name information available

Returns:

getTargetLanguage

@NotNull
public @NotNull String getTargetLanguage()

Get the target language (if available)

Returns:

getTmsProjectName

@NotNull
public @NotNull String getTmsProjectName()

Get the TMS project name

Returns:

getTmsFileName

@NotNull
public @NotNull String getTmsFileName()

Get the TMS file name in the project

Returns:

getCmsPageName

@NotNull
public @NotNull String getCmsPageName()

Get the associated CMS page name(s)

Returns:

getProjectId

@NotNull
public @NotNull String getProjectId()

Get the TMS Project of this file

Returns:

getFileId

@NotNull
public @NotNull String getFileId()

Internal File ID as used by the TMS

Returns:

Id