SAP ABAP Class CL_XLFT_API (XLIFF translation API)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-DOC-TTL (Application Component) Translation Tools
     ⤷ SLXE_XLFT (Package) XLIFF 1.2 Translation

Properties

Class	CL_XLFT_API
Short Description	XLIFF translation API
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status
Category	0
Package	SLXE_XLFT	XLIFF 1.2 Translation
Created	20101214	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	ABAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_XLFT_API has no interface implemented.

Friends

Class CL_XLFT_API has no friend class.

Attributes

Class CL_XLFT_API has no attribute.

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	COPY_OBJECT	Static method	Public	Method	Copies an object incl. translations to another location	20110223
2	DELETE	Static method	Public	Method	Deletes an XLIFF including translations	20110120
3	DELETE_TRANSLATION	Static method	Public	Method	Deletes the translation in the passed language	20110121
4	GET_LANGUAGES	Static method	Public	Method	Returns the languages an XLIFF is available in	20101228
5	GET_LAST_MODIFIED_TIMESTAMP	Static method	Public	Method	Returns the timestamp of last modification of a translation	20110120
6	GET_LAST_MODIFIED_TIMESTAMPS	Static method	Public	Method	Returns the timestamps of last modification per language	20110120
7	GET_METADATA	Static method	Public	Method	Reads the metadata of an XLIFF	20110120
8	GET_OBJECT_NAMES	Static method	Public	Method	Returns the object names that reside in passed collection	20101228
9	GET_ORIGINAL	Static method	Public	Method	Reads an existing original XLIFF from the translation system	20101228
10	GET_TRANSLATION	Static method	Public	Method	Returns the translation of an XLIFF	20101228
11	PUT_ORIGINAL	Static method	Public	Method	Writes an XLIFF to the translation system	20101214
12	PUT_TRANSLATION	Static method	Public	Method	Writes the translations of an XLIFF to the translation syste	20110512
13	TRANSPORT_TRANSLATIONS	Static method	Public	Method	Transports translations from one object to another one	20110223

Events

Class CL_XLFT_API has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TS_LANG	Public	See coding		Sorted list of languages	20101228	ts_lang TYPE SORTED TABLE OF lxeisolang WITH UNIQUE DEFAULT KEY
2	TS_OBJNAME	Public	See coding		Sorted list of object names	20101228	ts_objname TYPE SORTED TABLE OF lxeobjname WITH UNIQUE DEFAULT KEY

Method Signatures

Method COPY_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	OVERWRITE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Specifies if target object should be overwritten	20110223
2	Importing	SOURCE_AREA	Call by reference	☐	Type reference (TYPE)	LXECUSTMNR		Translation Area	20110223
3	Importing	SOURCE_OBJECT_NAME	Call by reference	☐	Type reference (TYPE)	LXEOBJNAME		Name of Translation Object	20110223
4	Importing	TARGET_AREA	Call by reference	☐	Type reference (TYPE)	LXECUSTMNR		Translation Area	20110223
5	Importing	TARGET_OBJECT_NAME	Call by reference	☐	Type reference (TYPE)	LXEOBJNAME		Name of Translation Object	20110223

#	Exception	Resumable	Description	Created on
1	CX_XLFT	☐	Base class for XLIFF Translation exceptions	20110223

Method DELETE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	AREA	Call by reference	☐	Type reference (TYPE)	LXECUSTMNR		Translation Area	20110120
2	Importing	OBJECT_NAME	Call by reference	☐	Type reference (TYPE)	LXEOBJNAME		Name of Translation Object	20110120

#	Exception	Resumable	Description	Created on
1	CX_XLFT	☐	Base class for XLIFF Translation exceptions	20110124

Method DELETE_TRANSLATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	AREA	Call by reference	☐	Type reference (TYPE)	LXECUSTMNR		Translation Area	20110121
2	Importing	LANGUAGE	Call by reference	☐	Type reference (TYPE)	LXEISOLANG		ISO Language ID	20110121
3	Importing	OBJECT_NAME	Call by reference	☐	Type reference (TYPE)	LXEOBJNAME		Name of Translation Object	20110121

#	Exception	Resumable	Description	Created on
1	CX_XLFT	☐	Base class for XLIFF Translation exceptions	20110124

Method GET_LANGUAGES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	AREA	Call by reference	☐	Type reference (TYPE)	LXECUSTMNR		Translation Area	20101228
2	Importing	OBJECT_NAME	Call by reference	☐	Type reference (TYPE)	LXEOBJNAME		Name of Translation Object	20101228
3	Exporting	ORIG_LANG	Call by reference	☐	Type reference (TYPE)	LXEISOLANG		Original language	20101228
4	Exporting	TRL_LANGS	Call by reference	☐	Type reference (TYPE)	TS_LANG		Translation languages	20101228

#	Exception	Resumable	Description	Created on
1	CX_XLFT	☐	Base class for XLIFF Translation exceptions	20110124

Method GET_LAST_MODIFIED_TIMESTAMP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	AREA	Call by reference	☐	Type reference (TYPE)	LXECUSTMNR		Translation Area	20110120
2	Importing	LANGUAGE	Call by reference	☐	Type reference (TYPE)	LXEISOLANG		ISO Language ID	20110120
3	Importing	OBJECT_NAME	Call by reference	☐	Type reference (TYPE)	LXEOBJNAME		Name of Translation Object	20110120
4	Returning	TIMESTAMP	Value transfer	☐	Type reference (TYPE)	TIMESTAMP		UTC Time Stamp in Short Form (YYYYMMDDhhmmss)	20110120

#	Exception	Resumable	Description	Created on
1	CX_XLFT	☐	Base class for XLIFF Translation exceptions	20110124

Method GET_LAST_MODIFIED_TIMESTAMPS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	AREA	Call by reference	☐	Type reference (TYPE)	LXECUSTMNR		Translation Area	20110120
2	Importing	OBJECT_NAME	Call by reference	☐	Type reference (TYPE)	LXEOBJNAME		Name of Translation Object	20110120
3	Returning	TIMESTAMPS	Value transfer	☐	Type reference (TYPE)	TXLFT_LANG_MODIFICATION_TS		Table of modification timestamp per language	20110120

#	Exception	Resumable	Description	Created on
1	CX_XLFT	☐	Base class for XLIFF Translation exceptions	20110124

Method GET_METADATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	AREA	Call by reference	☐	Type reference (TYPE)	LXECUSTMNR		Translation Area	20110120
2	Returning	METADATA	Value transfer	☐	Object reference (TYPE REF TO)	CL_XLFT_METADATA		SAP specific metadata	20110120
3	Importing	OBJECT_NAME	Call by reference	☐	Type reference (TYPE)	LXEOBJNAME		Name of Translation Object	20110120

#	Exception	Resumable	Description	Created on
1	CX_XLFT	☐	Base class for XLIFF Translation exceptions	20110124

Method GET_OBJECT_NAMES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	AREA	Call by reference	☐	Type reference (TYPE)	LXECUSTMNR		Translation Area	20101228
2	Importing	COLLECTION_NAME	Call by reference	☐	Type reference (TYPE)	LXECOLLNAM		Collection Name	20101228
3	Returning	OBJECT_NAMES	Value transfer	☐	Type reference (TYPE)	TS_OBJNAME		Sorted list of object names	20101228

#	Exception	Resumable	Description	Created on
1	CX_XLFT	☐	Base class for XLIFF Translation exceptions	20110124

Method GET_ORIGINAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	AREA	Call by reference	☐	Type reference (TYPE)	LXECUSTMNR		Translation Area	20101228
2	Importing	OBJECT_NAME	Call by reference	☐	Type reference (TYPE)	LXEOBJNAME		Name of Translation Object	20101228
3	Returning	ORIGINAL	Value transfer	☐	Type reference (TYPE)	XSTRING		Original XLIFF	20101228

#	Exception	Resumable	Description	Created on
1	CX_XLFT	☐	Base class for XLIFF Translation exceptions	20110124

Method GET_TRANSLATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	AREA	Call by reference	☐	Type reference (TYPE)	LXECUSTMNR		Translation Area	20101228
2	Importing	INCLUDE_COUNTRY	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Set to true if country should be included in language tag	20101228
3	Importing	INCLUDE_TRANS_STATUS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Set to true to incl. transl. status; high neg. perf. impact	20110221
4	Importing	LANGUAGE	Call by reference	☐	Type reference (TYPE)	LXEISOLANG		Language to export	20101228
5	Importing	OBJECT_NAME	Call by reference	☐	Type reference (TYPE)	LXEOBJNAME		Name of Translation Object	20101228
6	Returning	XLIFF	Value transfer	☐	Type reference (TYPE)	XSTRING		The translated XLIFF	20101228

#	Exception	Resumable	Description	Created on
1	CX_XLFT	☐	Base class for XLIFF Translation exceptions	20110124

Method PUT_ORIGINAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ALLOW_ORIG_LANG_CHANGE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	True if original language change should be allowed	20101216
2	Importing	AREA	Call by reference	☐	Type reference (TYPE)	LXECUSTMNR		Target translation area	20101214
3	Importing	METADATA	Call by reference	☑	Object reference (TYPE REF TO)	CL_XLFT_METADATA		SAP specific metadata	20101215
4	Importing	PASSED_METADATA_OVERRIDES	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	True if the passed metadata is to overwrite the embedded	20101215
5	Importing	SKIP_REVIEW	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	True if the review step should be skipped	20101215
6	Importing	XLIFF	Call by reference	☐	Type reference (TYPE)	XSTRING		XLIFF to be imported	20101214

#	Exception	Resumable	Description	Created on
1	CX_XLFT	☐	Base class for XLIFF Translation exceptions	20110124

Method PUT_TRANSLATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	AREA	Call by reference	☐	Type reference (TYPE)	LXECUSTMNR		Target translation area	20110512
2	Importing	OBJECT_NAME	Call by reference	☐	Type reference (TYPE)	LXEOBJNAME	''	Optional object name	20110516
3	Importing	OVERWRITE_EXISTING_TRANS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	True if existing translations should be overwritten	20110512
4	Importing	PASSED_OBJECT_NAME_OVERRIDES	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	True if the passed metadata is to overwrite the embedded	20110516
5	Importing	XLIFF	Call by reference	☐	Type reference (TYPE)	XSTRING		XLIFF with translation to be imported	20110512

#	Exception	Resumable	Description	Created on
1	CX_XLFT	☐	Base class for XLIFF Translation exceptions	20110512

Method TRANSPORT_TRANSLATIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	LANGUAGES	Call by reference	☐	Type reference (TYPE)	LXE_TT_LXEISOLANG		Languages to transport; if empty all langs are transported	20110223
2	Importing	OVERWRITE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Specifies if existing translation should be overwritten	20110223
3	Importing	SOURCE_AREA	Call by reference	☐	Type reference (TYPE)	LXECUSTMNR		Translation Area	20110223
4	Importing	SOURCE_OBJECT_NAME	Call by reference	☐	Type reference (TYPE)	LXEOBJNAME		Name of Translation Object	20110223
5	Importing	TARGET_AREA	Call by reference	☐	Type reference (TYPE)	LXECUSTMNR		Translation Area	20110223
6	Importing	TARGET_OBJECT_NAME	Call by reference	☐	Type reference (TYPE)	LXEOBJNAME		Name of Translation Object	20110223

#	Exception	Resumable	Description	Created on
1	CX_XLFT	☐	Base class for XLIFF Translation exceptions	20110223

History

Last changed by/on	SAP	20130531
SAP Release Created in	731