SAP ABAP Class CL_DITAT_LXE_API (DITA Translation API for SLXE package)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-DOC-TTL (Application Component) Translation Tools
⤷
SLXE_DITAT (Package) DITA Translation
SAP_BASIS (Software Component) SAP Basis Component⤷
BC-DOC-TTL (Application Component) Translation Tools⤷
SLXE_DITAT (Package) DITA TranslationProperties
| Class | CL_DITAT_LXE_API | |
| Short Description | DITA Translation API for SLXE package | |
| 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_LXE_API has no interface implemented.
Friends
Class CL_DITAT_LXE_API has no friend class.
Attributes
Class CL_DITAT_LXE_API has no attribute.
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | DEL_TRANSLATOR_COMMENT |
Static method | Public | Method | Deletes the translator comment of an object | 20121102 |
| 2 | DISPLAY_ON_PREVIEW_SERVER |
Static method | Public | Method | Displays an object on the preview server | 20130318 |
| 3 | EDIT |
Static method | Public | Method | Starts editor for DITA document | 20120914 |
| 4 | GET_AUTHOR_COMMENTS |
Static method | Public | Method | Returns author comments for an object | 20120914 |
| 5 | GET_COLLECTIONS |
Static method | Public | Method | Returns the list of collection | 20120914 |
| 6 | GET_OBJECT_LIST |
Static method | Public | Method | Returns an object list | 20120914 |
| 7 | GET_ORIGIN |
Static method | Public | Method | Returns the origin of an object | 20121120 |
| 8 | GET_RELATED_OBJECTS |
Static method | Public | Method | Returns related objects (PHIOs only) | 20121119 |
| 9 | GET_TECH_INFO |
Static method | Public | Method | Returns technical info on an object | 20120914 |
| 10 | GET_TEXT_CHANGE_DATA |
Static method | Public | Method | Returns change user, date and time of a text change | 20120914 |
| 11 | GET_TRANSLATION_STATUS |
Static method | Public | Method | Get translation status | 20120914 |
| 12 | GET_TRANSLATOR_COMMENT |
Static method | Public | Method | Returns the translator comment of an object | 20121102 |
| 13 | GET_TTX |
Static method | Public | Method | Return the TTX of a document | 20120914 |
| 14 | RESOLVE_LOGICAL_OBJECT_KEY |
Static method | Public | Method | Returns the physical object key of a logical object key | 20120928 |
| 15 | SET_TRANSLATOR_COMMENT |
Static method | Public | Method | Sets the translator comment of an object | 20121102 |
Events
Class CL_DITAT_LXE_API has no event.
Types
Class CL_DITAT_LXE_API has no local type.
Method Signatures
Method DEL_TRANSLATOR_COMMENT 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 | 20121102 | ||
| 2 | Importing |
OBJNAME | Call by reference | Type reference (TYPE) | LXEOBJNAME | Name of Translation Object | 20121102 | ||
| 3 | Importing |
OBJTYPE | Call by reference | Type reference (TYPE) | LXEOBJTYPE | Type of Translation Object | 20121102 | ||
| 4 | Importing |
TEXTKEY | Call by reference | Type reference (TYPE) | LXETEXTKEY | Text Key | 20121102 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_DITAT |
Base class for DITA translation related exceptions | 20121102 |
Method DISPLAY_ON_PREVIEW_SERVER 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 | 20130318 | ||
| 2 | Importing |
LANGUAGE | Call by reference | Type reference (TYPE) | LXEISOLANG | Translation Language | 20130318 | ||
| 3 | Importing |
OBJNAME | Call by reference | Type reference (TYPE) | LXEOBJNAME | Name of Translation Object | 20130318 | ||
| 4 | Importing |
OBJTYPE | Call by reference | Type reference (TYPE) | LXEOBJTYPE | Type of Translation Object | 20130318 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_DITAT |
Base class for DITA translation related exceptions | 20130318 |
Method 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 | Importing |
OBJNAME | Call by reference | Type reference (TYPE) | LXEOBJNAME | Name of Translation Object | 20120914 | ||
| 3 | Importing |
OBJTYPE | Call by reference | Type reference (TYPE) | LXEOBJTYPE | Type of Translation Object | 20120921 | ||
| 4 | Importing |
SEQUENTIAL | Call by reference | Type reference (TYPE) | CHAR1 | Single-Character Flag | 20120914 | ||
| 5 | Importing |
SLANG | Call by reference | Type reference (TYPE) | LXEISOLANG | Translation Language | 20120914 | ||
| 6 | Importing |
TLANG | Call by reference | Type reference (TYPE) | LXEISOLANG | Translation Language | 20120914 | ||
| 7 |  Returning |
UCOMM | Value transfer | Type reference (TYPE) | SYUCOMM | Function Code that Triggered PAI | 20120914 | ||
| 8 | 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 GET_AUTHOR_COMMENTS 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 |
AUTHOR_COMMENTS | Call by reference | Type reference (TYPE) | LXE_TT_KEY_DEVCOMMENT | Hashed table of text keys with developer comments | 20120914 | ||
| 3 | Importing |
OBJNAME | Call by reference | Type reference (TYPE) | LXEOBJNAME | Name of Translation Object | 20120914 | ||
| 4 | Importing |
OBJTYPE | Call by reference | Type reference (TYPE) | LXEOBJTYPE | Type of Translation Object | 20120924 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_DITAT |
Base class for DITA translation related exceptions | 20120914 |
Method GET_COLLECTIONS 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 |
COLLECTIONS | Call by reference | Type reference (TYPE) | LXE_COLLS_TABTYP | Collections | 20120914 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_DITAT |
Base class for DITA translation related exceptions | 20120914 |
Method GET_OBJECT_LIST 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 | Importing |
COLLNAM | Call by reference | Type reference (TYPE) | LXECOLLNAM | '*' | Collection Name | 20120914 | |
| 3 | Importing |
COLLTYP | Call by reference | Type reference (TYPE) | LXECOLLTYP | '*' | Collection Type | 20120914 | |
| 4 | Exporting |
COLOB | Call by reference | Type reference (TYPE) | LXE_TT_COLOB | Object lists table type | 20120914 | ||
| 5 | Importing |
LIKENAME | Call by reference | Type reference (TYPE) | LXEOBJNAME | '' | Name of Translation Object | 20120914 | |
| 6 | Importing |
OBJTYPE | Call by reference | Type reference (TYPE) | LXEOBJTYPE | Type of Translation Object | 20120914 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_DITAT |
Base class for DITA translation related exceptions | 20120914 |
Method GET_ORIGIN 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 | 20121120 | ||
| 2 | Importing |
OBJNAME | Call by reference | Type reference (TYPE) | LXEOBJNAME | Name of Translation Object | 20121120 | ||
| 3 | Importing |
OBJTYPE | Call by reference | Type reference (TYPE) | LXEOBJTYPE | Type of Translation Object | 20121120 | ||
| 4 | Returning |
ORIGIN | Value transfer | Type reference (TYPE) | STRING | 20121120 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_DITAT |
Base class for DITA translation related exceptions | 20121120 |
Method GET_RELATED_OBJECTS 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 | 20121119 | ||
| 2 | Exporting |
COLOB | Call by reference | Type reference (TYPE) | LXE_TT_COLOB | Object lists table type | 20121119 | ||
| 3 | Importing |
OBJNAME | Call by reference | Type reference (TYPE) | LXEOBJNAME | Name of Translation Object | 20121119 | ||
| 4 | Importing |
OBJTYPE | Call by reference | Type reference (TYPE) | LXEOBJTYPE | Type of Translation Object | 20121119 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_DITAT |
Base class for DITA translation related exceptions | 20121119 |
Method GET_TECH_INFO 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 |
CH_DATE | Call by reference | Type reference (TYPE) | AS4DATE | Date of Last Change | 20120914 | ||
| 3 | Exporting |
CH_TIME | Call by reference | Type reference (TYPE) | AS4TIME | Last changed at | 20120914 | ||
| 4 | Exporting |
CH_USER | Call by reference | Type reference (TYPE) | AS4USER | Last Changed by | 20120914 | ||
| 5 | Exporting |
COLLNAM | Call by reference | Type reference (TYPE) | LXECOLLNAM | Collection Name | 20120914 | ||
| 6 | Exporting |
COLLTXT | Call by reference | Type reference (TYPE) | LXECOLLTXT | Description Text for Collection | 20120914 | ||
| 7 | Exporting |
COLLTYP | Call by reference | Type reference (TYPE) | LXECOLLTYP | Collection Type | 20120914 | ||
| 8 | Exporting |
DESCRIPTION | Call by reference | Type reference (TYPE) | LXEUNITLIN | Translation Unit for Short Text (Line) | 20120914 | ||
| 9 | Exporting |
DEVELOPER | Call by reference | Type reference (TYPE) | LXEUNITLIN | Translation Unit for Short Text (Line) | 20120914 | ||
| 10 | Exporting |
DOMANAM | Call by reference | Type reference (TYPE) | LXEDOMANAM | Domain Name | 20120920 | ||
| 11 | Exporting |
DOMATXT | Call by reference | Type reference (TYPE) | LXEDOMATXT | Description Text for Domain | 20120914 | ||
| 12 | Exporting |
DOMATYP | Call by reference | Type reference (TYPE) | LXEDOMATYP | Domain Type | 20120914 | ||
| 13 | Importing |
OBJNAME | Call by reference | Type reference (TYPE) | LXEOBJNAME | Name of Translation Object | 20120914 | ||
| 14 | Importing |
OBJTYPE | Call by reference | Type reference (TYPE) | LXEOBJTYPE | Type of Translation Object | 20120914 | ||
| 15 | Exporting |
ORIG_LANG | Call by reference | Type reference (TYPE) | LXEISOLANG | Translation Language | 20120914 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_DITAT |
Base class for DITA translation related exceptions | 20120914 |
Method GET_TEXT_CHANGE_DATA 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 |
DATE | Call by reference | Type reference (TYPE) | AS4DATE | Date of Last Change | 20120914 | ||
| 3 | Importing |
LANG | Call by reference | Type reference (TYPE) | LXEISOLANG | Translation Language | 20120914 | ||
| 4 | Importing |
OBJNAME | Call by reference | Type reference (TYPE) | LXEOBJNAME | Name of Translation Object | 20120914 | ||
| 5 | Importing |
OBJTYPE | Call by reference | Type reference (TYPE) | LXEOBJTYPE | Type of Translation Object | 20120920 | ||
| 6 | Exporting |
TIME | Call by reference | Type reference (TYPE) | AS4TIME | Last changed at | 20120914 | ||
| 7 | Exporting |
USER | Call by reference | Type reference (TYPE) | AS4USER | Last Changed by | 20120914 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_DITAT |
Base class for DITA translation related exceptions | 20120914 |
Method GET_TRANSLATION_STATUS 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 |
CNTAVL | Call by reference | Type reference (TYPE) | LXECNTAVL | Available Translation Units | 20120914 | ||
| 3 | Exporting |
CNTMOD | Call by reference | Type reference (TYPE) | LXECNTMOD | Modified Translation Units | 20120914 | ||
| 4 | Exporting |
CNTNEW | Call by reference | Type reference (TYPE) | LXECNTNEW | Number of New Translation Units | 20120914 | ||
| 5 | Exporting |
CNTTOT | Call by reference | Type reference (TYPE) | LXECNTTOT | Total Number of Translation Units | 20120914 | ||
| 6 | Importing |
OBJNAME | Call by reference | Type reference (TYPE) | LXEOBJNAME | Name of Translation Object | 20120914 | ||
| 7 | Importing |
OBJTYPE | Call by reference | Type reference (TYPE) | LXEOBJTYPE | Type of Translation Object | 20120921 | ||
| 8 | Importing |
SLANG | Call by reference | Type reference (TYPE) | LXEISOLANG | Translation Language | 20120914 | ||
| 9 | Exporting |
STATTRN | Call by reference | Type reference (TYPE) | LXESTATTRN | Translation Status of an Object | 20120914 | ||
| 10 | Importing |
TLANG | Call by reference | Type reference (TYPE) | LXEISOLANG | Translation Language | 20120914 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_DITAT |
Base class for DITA translation related exceptions | 20120914 |
Method GET_TRANSLATOR_COMMENT 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 | 20121102 | ||
| 2 | Exporting |
COMMENT | Call by reference | Type reference (TYPE) | STRING | 20121102 | |||
| 3 | Exporting |
COMMENT_EXISTS | Call by reference | Type reference (TYPE) | ABAP_BOOL | 20121102 | |||
| 4 | Importing |
OBJNAME | Call by reference | Type reference (TYPE) | LXEOBJNAME | Name of Translation Object | 20121102 | ||
| 5 | Importing |
OBJTYPE | Call by reference | Type reference (TYPE) | LXEOBJTYPE | Type of Translation Object | 20121102 | ||
| 6 | Importing |
TEXTKEY | Call by reference | Type reference (TYPE) | LXETEXTKEY | Text Key | 20121102 | ||
| 7 | Exporting |
TIMESTAMP | Call by reference | Type reference (TYPE) | TIMESTAMP | UTC Time Stamp in Short Form (YYYYMMDDhhmmss) | 20121102 | ||
| 8 | Exporting |
USER | Call by reference | Type reference (TYPE) | SYUNAME | User Name | 20121102 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_DITAT |
Base class for DITA translation related exceptions | 20121102 |
Method GET_TTX 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 | Importing |
OBJNAME | Call by reference | Type reference (TYPE) | LXEOBJNAME | Name of Translation Object | 20120914 | ||
| 3 | Importing |
OBJTYPE | Call by reference | Type reference (TYPE) | LXEOBJTYPE | Type of Translation Object | 20120924 | ||
| 4 | Importing |
SLANG | Call by reference | Type reference (TYPE) | LXEISOLANG | Translation Language | 20120914 | ||
| 5 | Importing |
TLANG | Call by reference | Type reference (TYPE) | LXEISOLANG | Translation Language | 20120914 | ||
| 6 | Exporting |
TTX | Call by reference | Type reference (TYPE) | XSTRING | 20120914 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_DITAT |
Base class for DITA translation related exceptions | 20120914 |
Method RESOLVE_LOGICAL_OBJECT_KEY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
LOG_CUSTMNR | Call by reference | Type reference (TYPE) | LXECUSTMNR | Translation Area | 20121001 | ||
| 2 | Importing |
LOG_OBJNAME | Call by reference | Type reference (TYPE) | LXEOBJNAME | Name of Translation Object | 20121001 | ||
| 3 | Importing |
LOG_OBJTYPE | Call by reference | Type reference (TYPE) | LXEOBJTYPE | Type of Translation Object | 20121001 | ||
| 4 | Importing |
LOG_TARGETLANG | Call by reference | Type reference (TYPE) | LXEISOLANG | Translation Language | 20121001 | ||
| 5 | Exporting |
PHY_CUSTMNR | Call by reference | Type reference (TYPE) | LXECUSTMNR | Translation Area | 20121001 | ||
| 6 | Exporting |
PHY_OBJNAME | Call by reference | Type reference (TYPE) | LXEOBJNAME | Name of Translation Object | 20121001 | ||
| 7 | Exporting |
PHY_OBJTYPE | Call by reference | Type reference (TYPE) | LXEOBJTYPE | Type of Translation Object | 20121001 | ||
| 8 | Exporting |
PHY_TARGETLANG | Call by reference | Type reference (TYPE) | LXEISOLANG | Translation Language | 20121001 |
Method RESOLVE_LOGICAL_OBJECT_KEY on class CL_DITAT_LXE_API has no exception.
Method SET_TRANSLATOR_COMMENT 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 | 20121102 | ||
| 2 | Importing |
COMMENT | Call by reference | Type reference (TYPE) | STRING | 20121102 | |||
| 3 | Importing |
OBJNAME | Call by reference | Type reference (TYPE) | LXEOBJNAME | Name of Translation Object | 20121102 | ||
| 4 | Importing |
OBJTYPE | Call by reference | Type reference (TYPE) | LXEOBJTYPE | Type of Translation Object | 20121102 | ||
| 5 | Importing |
TEXTKEY | Call by reference | Type reference (TYPE) | LXETEXTKEY | Text Key | 20121102 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_DITAT |
Base class for DITA translation related exceptions | 20121102 |
History
| Last changed by/on | SAP | 20140121 |
| SAP Release Created in | 740 |
