SAP ABAP Class CL_DITAT_API (DITA Translation API)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-DOC-TTL (Application Component) Translation Tools
     ⤷ SLXE_DITAT (Package) DITA Translation

Properties

Class	CL_DITAT_API
Short Description	DITA Translation API
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status
Category	0
Package	SLXE_DITAT	DITA Translation
Created	20120829	SAP
Last change	20140121	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_DITAT_API has no interface implemented.

Friends

Class CL_DITAT_API has no friend class.

Attributes

Class CL_DITAT_API has no attribute.

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ABORT_STRUCT_TRANSFER	Static method	Public	Method	Aborts structural data transfer in progress	20121009
2	FINISH_STRUCT_TRANSFER	Static method	Public	Method	Finishes structural data transfer	20121009
3	GET_DELTA	Static method	Public	Method	Returns translations created/changed since timestamp	20120910
4	GET_LANGUAGES	Static method	Public	Method	Returns the languages a document is available in	20120914
5	GET_ORIGINAL	Static method	Public	Method	Returns an original and its metadata	20120912
6	GET_TEXT_IN_LANG	Static method	Public	Method	Returns a document in the given language	20130115
7	GET_TRANSLATION	Static method	Public	Method	Returns a translation of a document in given language	20120911
8	PUT_ORIGINAL	Static method	Public	Method	Puts an original to the translation system	20120905
9	PUT_TRANSLATION	Static method	Public	Method	Puts a translation to the translation system	20120907
10	START_STRUCT_TRANSFER	Static method	Public	Method	Starts structural data transfer	20121009
11	TRANSFER_BMAP	Static method	Public	Method	Transfers the data of a buildable map	20121009
12	TRANSFER_MAP	Static method	Public	Method	Transfers the data of a map	20121009
13	TRANSFER_PROJECT	Static method	Public	Method	Transfers the data of a project	20121009

Events

Class CL_DITAT_API has no event.

Types

Class CL_DITAT_API has no local type.

Method Signatures

Method ABORT_STRUCT_TRANSFER 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	20121009

#	Exception	Resumable	Description	Created on
1	CX_DITAT	☐	Base class for DITA translation related exceptions	20121009

Method FINISH_STRUCT_TRANSFER 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	20121009
2	Importing	TRANSFERTOKEN	Call by reference	☐	Type reference (TYPE)	DITAT_TRANSFERTOKEN		Structural data transfer token	20121009

#	Exception	Resumable	Description	Created on
1	CX_DITAT	☐	Base class for DITA translation related exceptions	20121009

Method GET_DELTA 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	20120910
2	Exporting	DELTA	Call by reference	☐	Type reference (TYPE)	DITAT_T_DELTA		Delta data (table of PHIO, language and revision)	20120910
3	Importing	INCLUDE_MIGRATED	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20120910
4	Importing	TIMESTAMP	Call by reference	☐	Type reference (TYPE)	TIMESTAMP		UTC Time Stamp in Short Form (YYYYMMDDhhmmss)	20120910

#	Exception	Resumable	Description	Created on
1	CX_DITAT	☐	Base class for DITA translation related exceptions	20120910

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	20120914
2	Exporting	ORG_LANG	Call by reference	☐	Type reference (TYPE)	DITAT_LANGUAGE		ISO-639-1-language '-' ISO-3166-country	20120914
3	Importing	PHIO	Call by reference	☐	Type reference (TYPE)	DITAT_PHIO		PHIO	20120914
4	Exporting	TRN_LANGS	Call by reference	☐	Type reference (TYPE)	DITAT_T_LANGUAGE		Sorted list of languages	20120914

#	Exception	Resumable	Description	Created on
1	CX_DITAT	☐	Base class for DITA translation related exceptions	20120914

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	20120912
2	Exporting	CONTENT	Call by reference	☐	Type reference (TYPE)	DITAT_BLOB		Binary data	20120912
3	Exporting	METADATA	Call by reference	☐	Type reference (TYPE)	DITAT_S_ORGMETADATA		Metadata of an original object	20120912
4	Importing	PHIO	Call by reference	☐	Type reference (TYPE)	DITAT_PHIO		PHIO	20120912

#	Exception	Resumable	Description	Created on
1	CX_DITAT	☐	Base class for DITA translation related exceptions	20120912

Method GET_TEXT_IN_LANG 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	20130115
2	Importing	LANG	Call by reference	☐	Type reference (TYPE)	LXEISOLANG		Translation Language	20130115
3	Importing	OBJNAME	Call by reference	☐	Type reference (TYPE)	LXEOBJNAME		Name of Translation Object	20130115
4	Importing	OBJTYPE	Call by reference	☐	Type reference (TYPE)	LXEOBJTYPE		Type of Translation Object	20130115
5	Returning	TEXT	Value transfer	☐	Type reference (TYPE)	XSTRING			20130115

#	Exception	Resumable	Description	Created on
1	CX_DITAT	☐	Base class for DITA translation related exceptions	20130115

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	20120911
2	Exporting	CONTENT	Call by reference	☐	Type reference (TYPE)	DITAT_BLOB		Binary data	20120911
3	Importing	LANG	Call by reference	☐	Type reference (TYPE)	DITAT_LANGUAGE		ISO-639-1-language '-' ISO-3166-country	20120912
4	Exporting	METADATA	Call by reference	☐	Type reference (TYPE)	DITAT_S_TRNMETADATA		Metadata on a translation	20120911
5	Importing	PHIO	Call by reference	☐	Type reference (TYPE)	DITAT_PHIO		PHIO	20120911

#	Exception	Resumable	Description	Created on
1	CX_DITAT	☐	Base class for DITA translation related exceptions	20120911

Method PUT_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	20120905
2	Importing	CONTENT	Call by reference	☐	Type reference (TYPE)	DITAT_BLOB		Binary data	20120905
3	Importing	METADATA	Call by reference	☐	Type reference (TYPE)	DITAT_S_ORGMETADATA		Metadata on physical objects	20120905
4	Importing	UPLOADMODE	Call by reference	☐	Type reference (TYPE)	DITAT_UPLOADMODE	'D'	Upload mode (default or recovery)	20121228
5	Returning	WAS_PUT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		True if the original has been put	20120907

#	Exception	Resumable	Description	Created on
1	CX_DITAT	☐	Base class for DITA translation related exceptions	20120905

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		Translation Area	20120907
2	Importing	CONTENT	Call by reference	☐	Type reference (TYPE)	DITAT_BLOB		Binary data	20120907
3	Importing	CREATE_FIPR_PAIR	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Create fingerprint pair for source/target	20120907
4	Importing	METADATA	Call by reference	☐	Type reference (TYPE)	DITAT_S_PTRNMETADATA		Metadata of translation for import	20120907
5	Importing	OVERWRITEMODE	Call by reference	☐	Type reference (TYPE)	DITAT_TRANSOVERWRITEMODE	'B'	Translation overwrite mode	20121010
6	Returning	WAS_PUT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20120907

#	Exception	Resumable	Description	Created on
1	CX_DITAT	☐	Base class for DITA translation related exceptions	20120907

Method START_STRUCT_TRANSFER 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	20121009
2	Returning	TRANSFERTOKEN	Value transfer	☐	Type reference (TYPE)	DITAT_TRANSFERTOKEN		Structural data transfer token	20121009

#	Exception	Resumable	Description	Created on
1	CX_DITAT	☐	Base class for DITA translation related exceptions	20121009

Method TRANSFER_BMAP 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	20121009
2	Importing	BMAP	Call by reference	☐	Type reference (TYPE)	DITAT_S_BMAP		Data of a buildable map	20121009
3	Importing	TRANSFERTOKEN	Call by reference	☐	Type reference (TYPE)	DITAT_TRANSFERTOKEN		Structural data transfer token	20121009

#	Exception	Resumable	Description	Created on
1	CX_DITAT	☐	Base class for DITA translation related exceptions	20121009

Method TRANSFER_MAP 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	20121009
2	Importing	MAP	Call by reference	☐	Type reference (TYPE)	DITAT_S_MAP		Data of a map	20121009
3	Importing	TRANSFERTOKEN	Call by reference	☐	Type reference (TYPE)	DITAT_TRANSFERTOKEN		Structural data transfer token	20121009

#	Exception	Resumable	Description	Created on
1	CX_DITAT	☐	Base class for DITA translation related exceptions	20121009

Method TRANSFER_PROJECT 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	20121009
2	Importing	PROJECT	Call by reference	☐	Type reference (TYPE)	DITAT_S_PROJECT		Data of a project	20121009
3	Importing	TRANSFERTOKEN	Call by reference	☐	Type reference (TYPE)	DITAT_TRANSFERTOKEN		Structural data transfer token	20121009

#	Exception	Resumable	Description	Created on
1	CX_DITAT	☐	Base class for DITA translation related exceptions	20121009

History

Last changed by/on	SAP	20140121
SAP Release Created in	740