SAP ABAP Class CL_DITAT_LXE_INTERFACE (Helper class that encapsulates LXE functions)

Hierarchy

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

Properties

Class	CL_DITAT_LXE_INTERFACE
Short Description	Helper class that encapsulates LXE functions
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	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)
2	IF_DITAT_INT_TYPES	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

Class CL_DITAT_LXE_INTERFACE has no interface implemented.

Friends

Class CL_DITAT_LXE_INTERFACE has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_EXT_MARK_USER	Constant	Private	☐	Type reference (TYPE)	AS4USER	'EXTERNAL'	Last Changed by	20130327
2	GT_LANGINFO	Static Attribute	Private	☐	Type reference (TYPE)	T_LANGINFO			20121106
3	GT_LANGTAG2LANG	Static Attribute	Private	☐	Type reference (TYPE)	T_LANGTAG2LANG			20120904
4	GV_LANGS_CACHED	Static Attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20120904

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ASSIGN_COLLS_TO_GRAPH	Static method	Public	Method	Assign collections to a graph	20121112
2	ASSIGN_COLLS_TO_USERS	Static method	Public	Method	Assign collections to translators	20121108
3	CACHE_LANGUAGES	Static method	Private	Method		20120904
4	CREATE_PROJECT	Static method	Public	Method	Creates a project	20121220
5	DELETE_PROJECT	Static method	Public	Method	Deletes a project	20121220
6	DELETE_VANISHED_COLLS	Static method	Public	Method	Remove vanished collections from LXE_COLLX	20121022
7	DRAW_GRAPH	Static method	Public	Method	Creates a new graph	20121108
8	FREE_GRAPH	Static method	Public	Method	Marks a graph as free	20121114
9	GET_COLLECTION_TEXT	Static method	Public	Method	Returns the text of a collection	20120920
10	GET_DOMAIN_TEXT	Static method	Public	Method	Returns the text of a domain	20120920
11	GET_LAISO	Static method	Private	Method		20121114
12	GET_R3_LANG	Static method	Public	Method	Returns the R3 language of a language	20121106
13	GRAPH_CONTAINS_COLLS	Static method	Public	Method	Checks if any collections are assigned to a graph	20121112
14	INSERT_NEW_AND_UPDATE_COLLS	Static method	Public	Method	Register new/updated collections in LXE_COLLX	20121022
15	LONG_TEXT_EDIT	Static method	Public	Method	Calls the long-text editiong functionality	20120914
16	MAP_LANGTAG_TO_LANG	Static method	Public	Method	Maps a RFC 5646 language tag to a language	20120904
17	MAP_LANG_TO_LANGTAG	Static method	Public	Method	Maps a language to a RFC 5646 language tag	20120904
18	MULT_CC_VERSION_INFO	Static method	Public	Method	Warning if the content container version is not unique	20121004
19	SET_GRAPH_TARGETLANGS	Static method	Public	Method	Sets the target languages of a graph	20121108
20	UNASSIGN_COLLS_FROM_GRAPHS	Static method	Public	Method	Unassign collections that don't exist any longer	20121112
21	UNASSIGN_COLLS_FROM_USERS	Static method	Public	Method	Unassign collections from translators	20121108
22	UPDATE_PROJECT	Static method	Public	Method	Updates a project	20121220
23	VERIFY_AREA	Static method	Public	Method	Verifies that the passed area is a DITA translation area	20120904
24	VERIFY_DOMAIN	Static method	Public	Method	Verifies that the domain is known by the translation system	20120904
25	VERIFY_LANG	Static method	Public	Method	Verifies that a language is known by the translation system	20120924
26	WORKLIST_POOL_MARK_TRANSLATED	Static method	Public	Method	Marks an object to be translated in the worklist pool	20121116

Events

Class CL_DITAT_LXE_INTERFACE has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	S_LANGINFO	Private	See coding			20121106	BEGIN OF s_langinfo, isolang TYPE lxeisolang, lang TYPE c LENGTH 2, region TYPE c LENGTH 2, r3lang TYPE spras, END OF s_langinfo
2	S_LANGTAG2LANG	Private	See coding			20120904	BEGIN OF s_langtag2lang, lang TYPE c LENGTH 2, region TYPE c LENGTH 2, isolang TYPE lxeisolang, END OF s_langtag2lang
3	T_LANGINFO	Private	See coding			20121106	t_langinfo TYPE HASHED TABLE OF s_langinfo WITH UNIQUE KEY isolang
4	T_LANGTAG2LANG	Private	See coding			20120904	t_langtag2lang TYPE HASHED TABLE OF s_langtag2lang WITH UNIQUE KEY lang region

Method Signatures

Method ASSIGN_COLLS_TO_GRAPH 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	20121112
2	Importing	COLLS	Call by reference	☐	Type reference (TYPE)	IF_DITAT_INT_TYPES=>T_COLLNAM			20121112
3	Importing	GRAPH	Call by reference	☐	Type reference (TYPE)	LXEGRAPH		Translation graph	20121112

Method ASSIGN_COLLS_TO_GRAPH on class CL_DITAT_LXE_INTERFACE has no exception.

Method ASSIGN_COLLS_TO_USERS 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			20121108
2	Importing	CURRENT_ASSIGNMENTS	Call by reference	☐	Type reference (TYPE)	IF_DITAT_INT_TYPES=>T_COLL_TRANSLATORS			20121108
3	Importing	RELEVANT_LANGS	Call by reference	☐	Type reference (TYPE)	IF_DITAT_INT_TYPES=>T_LANG			20121126

Method ASSIGN_COLLS_TO_USERS on class CL_DITAT_LXE_INTERFACE has no exception.

Method CACHE_LANGUAGES Signature

Method CACHE_LANGUAGES on class CL_DITAT_LXE_INTERFACE has no parameter.
Method CACHE_LANGUAGES on class CL_DITAT_LXE_INTERFACE has no exception.

Method CREATE_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	20121220
2	Importing	COLLS	Call by reference	☐	Type reference (TYPE)	IF_DITAT_INT_TYPES=>T_COLLNAM			20121220
3	Returning	LXEPROJID	Value transfer	☐	Type reference (TYPE)	LXE_PROJ_ID		Project ID	20121220
4	Importing	PROJECTNAME	Call by reference	☐	Type reference (TYPE)	STRING			20121220

#	Exception	Resumable	Description	Created on
1	CX_DITAT_PROJECT_LXE	☐	Project exception in package SLXE	20121220

Method DELETE_PROJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	LXEPROJID	Call by reference	☐	Type reference (TYPE)	LXE_PROJ_ID		Project ID	20121220

Method DELETE_PROJECT on class CL_DITAT_LXE_INTERFACE has no exception.

Method DELETE_VANISHED_COLLS 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			20121022
2	Importing	COLLX	Call by reference	☐	Type reference (TYPE)	IF_DITAT_INT_TYPES=>T_COLLX			20121022

Method DELETE_VANISHED_COLLS on class CL_DITAT_LXE_INTERFACE has no exception.

Method DRAW_GRAPH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	GRAPH	Value transfer	☐	Type reference (TYPE)	LXEGRAPH		Translation graph	20121108

#	Exception	Resumable	Description	Created on
1	CX_DITAT_GRAPH_LXE	☐	Graph exception in SLXE package	20121109

Method FREE_GRAPH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	GRAPH	Call by reference	☐	Type reference (TYPE)	LXEGRAPH		Translation graph	20121114

#	Exception	Resumable	Description	Created on
1	CX_DITAT_GRAPH	☐	Graph related exception	20121114

Method GET_COLLECTION_TEXT 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	20120920
2	Importing	COLLNAM	Call by reference	☐	Type reference (TYPE)	LXECOLLNAM		Collection Name	20120920
3	Returning	COLLTXT	Value transfer	☐	Type reference (TYPE)	LXECOLLTXT		Description Text for Collection	20120920

Method GET_COLLECTION_TEXT on class CL_DITAT_LXE_INTERFACE has no exception.

Method GET_DOMAIN_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOMANAM	Call by reference	☐	Type reference (TYPE)	LXEDOMANAM		Domain Name	20120920
2	Returning	DOMATXT	Value transfer	☐	Type reference (TYPE)	LXEDOMATXT		Description Text for Domain	20120920
3	Importing	DOMATYP	Call by reference	☐	Type reference (TYPE)	LXEDOMATYP		Domain Type	20120920

Method GET_DOMAIN_TEXT on class CL_DITAT_LXE_INTERFACE has no exception.

Method GET_LAISO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	LAISO	Value transfer	☐	Type reference (TYPE)	LAISO		Language according to ISO 639	20121114
2	Importing	LANG	Call by reference	☐	Type reference (TYPE)	LXEISOLANG		Translation Language	20121114

Method GET_LAISO on class CL_DITAT_LXE_INTERFACE has no exception.

Method GET_R3_LANG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	LANG	Call by reference	☐	Type reference (TYPE)	LXEISOLANG		Translation Language	20121106
2	Returning	R3_LANG	Value transfer	☐	Type reference (TYPE)	SPRAS		Language Key	20121106

#	Exception	Resumable	Description	Created on
1	CX_DITAT_LANG_INVALID	☐	Invalid translation system language	20121106

Method GRAPH_CONTAINS_COLLS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	CONTAINS_COLLS	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20121112
2	Importing	GRAPH	Call by reference	☐	Type reference (TYPE)	LXEGRAPH		Translation graph	20121112

Method GRAPH_CONTAINS_COLLS on class CL_DITAT_LXE_INTERFACE has no exception.

Method INSERT_NEW_AND_UPDATE_COLLS 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			20121022
2	Importing	COLLX	Call by reference	☐	Type reference (TYPE)	IF_DITAT_INT_TYPES=>T_COLLX			20121022

Method INSERT_NEW_AND_UPDATE_COLLS on class CL_DITAT_LXE_INTERFACE has no exception.

Method LONG_TEXT_EDIT 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	CANCELLED	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20120914
3	Importing	CCNAME	Call by reference	☐	Type reference (TYPE)	STRING			20121114
4	Importing	COLLNAM	Call by reference	☐	Type reference (TYPE)	LXECOLLNAM		Collection Name	20120914
5	Importing	DOMANAM	Call by reference	☐	Type reference (TYPE)	LXEDOMANAM		Domain Name	20120914
6	Exporting	NEW_TTEXT	Call by reference	☐	Type reference (TYPE)	XSTRING			20120914
7	Exporting	NEW_TTX	Call by reference	☐	Type reference (TYPE)	XSTRING			20120914
8	Importing	OBJNAME	Call by reference	☐	Type reference (TYPE)	LXEOBJNAME		Name of Translation Object	20120914
9	Importing	OBJTYPE	Call by reference	☐	Type reference (TYPE)	LXEOBJTYPE		Type of Translation Object	20120914
10	Importing	OLANG	Call by reference	☐	Type reference (TYPE)	LXEISOLANG		Translation Language	20120914
11	Importing	SEQUENTIAL	Call by reference	☐	Type reference (TYPE)	CHAR1		Single-Character Flag	20120914
12	Importing	SLANG	Call by reference	☐	Type reference (TYPE)	LXEISOLANG		Translation Language	20120914
13	Importing	STATTRN	Call by reference	☐	Type reference (TYPE)	LXESTATTRN		Translation Status of an Object	20120924
14	Importing	STEXT	Call by reference	☐	Type reference (TYPE)	XSTRING			20120914
15	Importing	TLANG	Call by reference	☐	Type reference (TYPE)	LXEISOLANG		Translation Language	20120914
16	Importing	TTEXT	Call by reference	☐	Type reference (TYPE)	XSTRING			20120914
17	Importing	TTX	Call by reference	☐	Type reference (TYPE)	XSTRING			20120914
18	Exporting	UCOMM	Call by reference	☐	Type reference (TYPE)	SYUCOMM		Function Code that Triggered PAI	20120914
19	Importing	VWO	Call by reference	☐	Type reference (TYPE)	CHAR1		Single-Character Flag	20120914

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

Method MAP_LANGTAG_TO_LANG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	LANG	Value transfer	☐	Type reference (TYPE)	LXEISOLANG		Translation Language	20120904
2	Importing	LANGTAG	Call by reference	☐	Type reference (TYPE)	DITAT_LANGUAGE		RFC 5646 language tag	20120904

#	Exception	Resumable	Description	Created on
1	CX_DITAT_LANG_LANGTAG_NS	☐	Language tag is not supported	20120904

Method MAP_LANG_TO_LANGTAG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	LANG	Call by reference	☐	Type reference (TYPE)	LXEISOLANG		Translation Language	20120904
2	Returning	LANGTAG	Value transfer	☐	Type reference (TYPE)	DITAT_LANGUAGE		RFC 5646 language tag	20120904

#	Exception	Resumable	Description	Created on
1	CX_DITAT_LANG_INVALID	☐	Invalid translation system language	20120904
2	CX_DITAT_LANG_NO_LANGTAG	☐	Translation system language does not have a language tag	20120904

Method MULT_CC_VERSION_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_PRC_CONTINUE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20121004
2	Exporting	EV_PRC_STATUS	Call by reference	☐	Type reference (TYPE)	LXESTATPRC		Process Status	20121004
3	Importing	IS_CC_VERS_COMP	Call by reference	☐	Type reference (TYPE)	DITAT_S_CC_VERS_COMP		Content container version check	20121004

Method MULT_CC_VERSION_INFO on class CL_DITAT_LXE_INTERFACE has no exception.

Method SET_GRAPH_TARGETLANGS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	GRAPH	Call by reference	☐	Type reference (TYPE)	LXEGRAPH		Translation graph	20121108
2	Importing	TLANGS	Call by reference	☐	Type reference (TYPE)	IF_DITAT_INT_TYPES=>T_LANG			20121108

#	Exception	Resumable	Description	Created on
1	CX_DITAT_GRAPH	☐	Graph related exception	20121109

Method UNASSIGN_COLLS_FROM_GRAPHS 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	20121112
2	Importing	EXISTING_COLLS	Call by reference	☐	Type reference (TYPE)	IF_DITAT_INT_TYPES=>T_COLLNAM			20121112

Method UNASSIGN_COLLS_FROM_GRAPHS on class CL_DITAT_LXE_INTERFACE has no exception.

Method UNASSIGN_COLLS_FROM_USERS 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			20121108
2	Importing	CURRENT_ASSIGNMENTS	Call by reference	☐	Type reference (TYPE)	IF_DITAT_INT_TYPES=>T_COLL_TRANSLATORS			20121108
3	Importing	EXISTING_COLLS	Call by reference	☐	Type reference (TYPE)	IF_DITAT_INT_TYPES=>T_COLLNAM			20121108
4	Importing	RELEVANT_LANGS	Call by reference	☐	Type reference (TYPE)	IF_DITAT_INT_TYPES=>T_LANG			20121108

Method UNASSIGN_COLLS_FROM_USERS on class CL_DITAT_LXE_INTERFACE has no exception.

Method UPDATE_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	20121220
2	Importing	COLLS	Call by reference	☐	Type reference (TYPE)	IF_DITAT_INT_TYPES=>T_COLLNAM			20121220
3	Importing	LXEPROJID	Call by reference	☐	Type reference (TYPE)	LXE_PROJ_ID		Project ID	20121220
4	Importing	PROJECTNAME	Call by reference	☐	Type reference (TYPE)	STRING			20121220

#	Exception	Resumable	Description	Created on
1	CX_DITAT_PROJECT_LXE	☐	Project exception in package SLXE	20121220

Method VERIFY_AREA 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	20120904

#	Exception	Resumable	Description	Created on
1	CX_DITAT_AREA_DOES_NOT_EXIST	☐	Translation area does not exist	20120904
2	CX_DITAT_AREA_WRONG_TYPE	☐	Wrong translation area type	20120904

Method VERIFY_DOMAIN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOMAIN	Call by reference	☐	Type reference (TYPE)	LXEDOMANAM		Domain Name	20120904
2	Returning	DOMAIN_TYPE	Value transfer	☐	Type reference (TYPE)	LXEDOMATYP		Domain Type	20120904

#	Exception	Resumable	Description	Created on
1	CX_DITAT_DOMAIN_UNKNOWN	☐	Unknown terminology domain	20120904

Method VERIFY_LANG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	LANG	Call by reference	☐	Type reference (TYPE)	LXEISOLANG		Translation Language	20120924

#	Exception	Resumable	Description	Created on
1	CX_DITAT_LANG_INVALID	☐	Invalid translation system language	20120924

Method WORKLIST_POOL_MARK_TRANSLATED 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	20121116
2	Importing	OBJNAME	Call by reference	☐	Type reference (TYPE)	LXEOBJNAME		Name of Translation Object	20121116
3	Importing	OBJTYPE	Call by reference	☐	Type reference (TYPE)	LXEOBJTYPE		Type of Translation Object	20121116
4	Importing	SLANG	Call by reference	☐	Type reference (TYPE)	LXEISOLANG		Translation Language	20121116
5	Importing	TLANG	Call by reference	☐	Type reference (TYPE)	LXEISOLANG		Translation Language	20121116

Method WORKLIST_POOL_MARK_TRANSLATED on class CL_DITAT_LXE_INTERFACE has no exception.

History

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