SAP ABAP Class CL_XLFT_LXE_API (XLIFF translation API for LXE package)
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_LXE_API | |
| Short Description | XLIFF translation API for LXE package | |
| 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 | 20101223 | SAP |
| Last change | 20140121 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Class CL_XLFT_LXE_API has no interface implemented.
Friends
Class CL_XLFT_LXE_API has no friend class.
Attributes
Class CL_XLFT_LXE_API has no attribute.
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Static method | Public | Method | Deletes a translator comment for a text | 20110120 | |
| 2 | Static method | Public | Method | Deletes objects in passed collections | 20120720 | |
| 3 | Static method | Public | Method | Starts editor for ZXLF object | 20101231 | |
| 4 | Static method | Public | Method | Returns a translation unit containing all translations | 20110218 | |
| 5 | Static method | Public | Method | Returns the list of collections | 20101223 | |
| 6 | Static method | Public | Method | Returns a translator comment for a text | 20110120 | |
| 7 | Static method | Public | Method | Returns developer comments of an XLIFF | 20111118 | |
| 8 | Static method | Public | Method | Returns an object list | 20101223 | |
| 9 | Static method | Public | Method | Returns the origin of an XLIFF | 20110308 | |
| 10 | Static method | Public | Method | Returns related objects of an object | 20110111 | |
| 11 | Static method | Public | Method | Returns the short text length threshold | 20130613 | |
| 12 | Static method | Public | Method | Returns tech infos on an object | 20101223 | |
| 13 | Static method | Public | Method | Returns change user, date and time of a text change | 20110224 | |
| 14 | Static method | Public | Method | Get long text translation status | 20110111 | |
| 15 | Static method | Public | Method | Returns the TTX of a document | 20120314 | |
| 16 | Static method | Public | Method | Returns the texts appearing in a ZXLF object | 20120208 | |
| 17 | Static method | Public | Method | Reads short text pairs | 20101223 | |
| 18 | Static method | Public | Method | Writes a translator comment for a text | 20110120 | |
| 19 | Static method | Public | Method | Sets the short text length threshold | 20130613 | |
| 20 | Static method | Public | Method | Write short text pairs | 20101227 |
Events
Class CL_XLFT_LXE_API has no event.
Types
Class CL_XLFT_LXE_API has no local type.
Method Signatures
Method DELETE_COMMENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | AREA | Call by reference | Type reference (TYPE) | LXECUSTMNR | Translation Area | 20110120 | |||
| 2 | OBJECT_NAME | Call by reference | Type reference (TYPE) | LXEOBJNAME | Name of Translation Object | 20110120 | |||
| 3 | OBJECT_TYPE | Call by reference | Type reference (TYPE) | LXEOBJTYPE | Type of Translation Object | 20110120 | |||
| 4 | TEXTKEY | Call by reference | Type reference (TYPE) | LXETEXTKEY | Text Key | 20110120 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Base class for XLIFF Translation exceptions | 20110124 |
Method DELETE_OBJECTS_IN_COLLS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | COLLECTIONS | Call by reference | Type reference (TYPE) | LXE_COLLS_TABTYP | Collections | 20120720 | |||
| 2 | OLDER_THAN | Call by reference | Type reference (TYPE) | DATS | '99991231' | Field of type DATS | 20120720 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Base class for XLIFF Translation exceptions | 20120720 |
Method EDIT_ZXLF Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | AREA | Call by reference | Type reference (TYPE) | LXECUSTMNR | Translation Area | 20101231 | |||
| 2 | OBJECT_NAME | Call by reference | Type reference (TYPE) | LXEOBJNAME | Name of Translation Object | 20101231 | |||
| 3 | SEQUENTIAL | Call by reference | Type reference (TYPE) | CHAR1 | Single-Character Flag | 20120131 | |||
| 4 | SOURCE_LANG | Call by reference | Type reference (TYPE) | LXEISOLANG | ISO Language ID | 20101231 | |||
| 5 | TARGET_LANG | Call by reference | Type reference (TYPE) | LXEISOLANG | ISO Language ID | 20101231 | |||
| 6 | UCOMM | Value transfer | Type reference (TYPE) | SYUCOMM | Function code that PAI triggered | 20101231 | |||
| 7 | VWO | Call by reference | Type reference (TYPE) | CHAR1 | Single-Character Flag | 20101231 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Base class for XLIFF Translation exceptions | 20110124 |
Method GET_ALL_TRANS_TRANS_UNIT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | AREA | Call by reference | Type reference (TYPE) | LXECUSTMNR | Translation Area | 20110218 | |||
| 2 | OBJECT_NAME | Call by reference | Type reference (TYPE) | LXEOBJNAME | Name of Translation Object | 20110218 | |||
| 3 | TEXTKEY | Call by reference | Type reference (TYPE) | LXETEXTKEY | Text Key | 20110218 | |||
| 4 | TRANS_UNIT_XML | Value transfer | Type reference (TYPE) | XSTRING | Translation unit containing all translations | 20110218 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Base class for XLIFF Translation exceptions | 20110218 |
Method GET_COLLECTIONS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | AREA | Call by reference | Type reference (TYPE) | LXECUSTMNR | Translation Area | 20101223 | |||
| 2 | COLLECTIONS | Call by reference | Type reference (TYPE) | LXE_COLLS_TABTYP | Collections | 20101223 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Base class for XLIFF Translation exceptions | 20110124 |
Method GET_COMMENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | AREA | Call by reference | Type reference (TYPE) | LXECUSTMNR | Translation Area | 20110120 | |||
| 2 | COMMENT | Call by reference | Type reference (TYPE) | LXE_S_REMRKS_STE | Short text comment | 20110120 | |||
| 3 | COMMENT_EXISTS | Call by reference | Type reference (TYPE) | ABAP_BOOL | True if a comment exists, false otherwise | 20110120 | |||
| 4 | OBJECT_NAME | Call by reference | Type reference (TYPE) | LXEOBJNAME | Name of Translation Object | 20110120 | |||
| 5 | OBJECT_TYPE | Call by reference | Type reference (TYPE) | LXEOBJTYPE | Type of Translation Object | 20110120 | |||
| 6 | TEXTKEY | Call by reference | Type reference (TYPE) | LXETEXTKEY | Text Key | 20110120 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Base class for XLIFF Translation exceptions | 20110124 |
Method GET_DEV_COMMENTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | AREA | Call by reference | Type reference (TYPE) | LXECUSTMNR | Translation Area | 20111118 | |||
| 2 | DEV_COMMENTS | Value transfer | Type reference (TYPE) | LXE_TT_KEY_DEVCOMMENT | Hashed table of text keys with developer comments | 20111118 | |||
| 3 | OBJECT_NAME | Call by reference | Type reference (TYPE) | LXEOBJNAME | Name of Translation Object | 20111118 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Base class for XLIFF Translation exceptions | 20111118 |
Method GET_OBJECT_LIST Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | AREA | Call by reference | Type reference (TYPE) | LXECUSTMNR | Translation Area | 20101223 | |||
| 2 | COLLNAM | Call by reference | Type reference (TYPE) | LXECOLLNAM | '*' | Collection Name | 20101223 | ||
| 3 | COLLTYP | Call by reference | Type reference (TYPE) | LXECOLLTYP | '*' | Collection Type | 20101223 | ||
| 4 | COLOB | Call by reference | Type reference (TYPE) | LXE_TT_COLOB | Object Lists | 20101223 | |||
| 5 | LIKENAME | Call by reference | Type reference (TYPE) | LXEOBJNAME | '' | Name of Translation Object | 20101223 | ||
| 6 | OBJTYPE | Call by reference | Type reference (TYPE) | LXEOBJTYPE | Type of Translation Object | 20101223 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Base class for XLIFF Translation exceptions | 20110124 |
Method GET_ORIGIN Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | AREA | Call by reference | Type reference (TYPE) | LXECUSTMNR | Translation Area | 20110308 | |||
| 2 | OBJECT_NAME | Call by reference | Type reference (TYPE) | LXEOBJNAME | Name of Translation Object | 20110308 | |||
| 3 | ORIGIN | Value transfer | Type reference (TYPE) | STRING | The origin or initial if not available | 20110308 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Base class for XLIFF Translation exceptions | 20110308 |
Method GET_RELATED_OBJECTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | AREA | Call by reference | Type reference (TYPE) | LXECUSTMNR | Translation Area | 20110111 | |||
| 2 | COLOB | Value transfer | Type reference (TYPE) | LXE_TT_COLOB | Object lists table type | 20110111 | |||
| 3 | OBJECT_NAME | Call by reference | Type reference (TYPE) | LXEOBJNAME | Name of Translation Object | 20110111 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Base class for XLIFF Translation exceptions | 20110124 |
Method GET_STEXT_THRESHOLD Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | AREA | Call by reference | Type reference (TYPE) | LXECUSTMNR | Translation Area | 20130613 | |||
| 2 | THRESHOLD | Value transfer | Type reference (TYPE) | LXEUNITMLT | Maximum Length of Translation Unit | 20130613 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Base class for XLIFF Translation exceptions | 20130613 |
Method GET_TECH_INFO Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | AREA | Call by reference | Type reference (TYPE) | LXECUSTMNR | Translation Area | 20101223 | |||
| 2 | CH_DATE | Call by reference | Type reference (TYPE) | LXE_PC_HD-CH_DATE | Date of Last Change | 20101223 | |||
| 3 | CH_TIME | Call by reference | Type reference (TYPE) | LXE_PC_HD-CH_TIME | Last changed at | 20101223 | |||
| 4 | CH_USER | Call by reference | Type reference (TYPE) | LXE_PC_HD-CH_USER | Last Changed by | 20101223 | |||
| 5 | COLLNAM | Call by reference | Type reference (TYPE) | LXECOLLNAM | Collection Name | 20101223 | |||
| 6 | COLLTXT | Call by reference | Type reference (TYPE) | LXECOLLTXT | Description Text for Collection | 20101223 | |||
| 7 | COLLTYP | Call by reference | Type reference (TYPE) | LXECOLLTYP | Collection Type | 20101223 | |||
| 8 | DESCRIPTION | Call by reference | Type reference (TYPE) | LXEUNITLIN | Translation Unit for Short Text (Line) | 20101223 | |||
| 9 | DEVELOPER | Call by reference | Type reference (TYPE) | LXEUNITLIN | Translation Unit for Short Text (Line) | 20101223 | |||
| 10 | DOMANAM | Call by reference | Type reference (TYPE) | LXEDOMANAM | Domain Name | 20101223 | |||
| 11 | DOMATXT | Call by reference | Type reference (TYPE) | LXEDOMATXT | Description Text for Domain | 20101223 | |||
| 12 | DOMATYP | Call by reference | Type reference (TYPE) | LXEDOMATYP | Domain Type | 20101223 | |||
| 13 | OBJNAME | Call by reference | Type reference (TYPE) | LXEOBJNAME | Name of Translation Object | 20101223 | |||
| 14 | OBJTYPE | Call by reference | Type reference (TYPE) | LXEOBJTYPE | Type of Translation Object | 20101223 | |||
| 15 | ORIG_LANG | Call by reference | Type reference (TYPE) | LXEISOLANG | ISO Language ID | 20101223 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Base class for XLIFF Translation exceptions | 20110124 |
Method GET_TEXT_CHANGE_DATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | AREA | Call by reference | Type reference (TYPE) | LXECUSTMNR | Translation Area | 20110224 | |||
| 2 | DATE | Call by reference | Type reference (TYPE) | AS4DATE | Date of Last Change | 20110224 | |||
| 3 | LANGUAGE | Call by reference | Type reference (TYPE) | LXEISOLANG | ISO Language ID | 20110224 | |||
| 4 | OBJECT_NAME | Call by reference | Type reference (TYPE) | LXEOBJNAME | Name of Translation Object | 20110224 | |||
| 5 | OBJECT_TYPE | Call by reference | Type reference (TYPE) | LXEOBJTYPE | Type of Translation Object | 20130513 | |||
| 6 | TEXTKEY | Call by reference | Type reference (TYPE) | LXETEXTKEY | Text Key | 20110224 | |||
| 7 | TIME | Call by reference | Type reference (TYPE) | AS4TIME | Last changed at | 20110224 | |||
| 8 | USER | Call by reference | Type reference (TYPE) | AS4USER | Last Changed by | 20110224 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Base class for XLIFF Translation exceptions | 20110224 |
Method GET_TRANSLATION_STATUS_ZXLF Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | AREA | Call by reference | Type reference (TYPE) | LXECUSTMNR | Translation Area | 20110111 | |||
| 2 | CNTAVL | Call by reference | Type reference (TYPE) | LXECNTAVL | Available Translation Units | 20110111 | |||
| 3 | CNTMOD | Call by reference | Type reference (TYPE) | LXECNTMOD | Modified Translation Units | 20110111 | |||
| 4 | CNTNEW | Call by reference | Type reference (TYPE) | LXECNTNEW | Number of New Translation Units | 20110111 | |||
| 5 | CNTTOT | Call by reference | Type reference (TYPE) | LXECNTTOT | Total Number of Translation Units | 20110111 | |||
| 6 | OBJECT_NAME | Call by reference | Type reference (TYPE) | LXEOBJNAME | Name of Translation Object | 20110111 | |||
| 7 | SOURCE_LANG | Call by reference | Type reference (TYPE) | LXEISOLANG | ISO Language ID | 20110111 | |||
| 8 | STATTRN | Call by reference | Type reference (TYPE) | LXESTATTRN | Translation Status | 20110111 | |||
| 9 | TARGET_LANG | Call by reference | Type reference (TYPE) | LXEISOLANG | ISO Language ID | 20110111 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Base class for XLIFF Translation exceptions | 20110124 |
Method GET_TTX Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | AREA | Call by reference | Type reference (TYPE) | LXECUSTMNR | Translation Area | 20120314 | |||
| 2 | OBJECT_NAME | Call by reference | Type reference (TYPE) | LXEOBJNAME | Name of Translation Object | 20120314 | |||
| 3 | SOURCE_LANG | Call by reference | Type reference (TYPE) | LXEISOLANG | Translation Language | 20120314 | |||
| 4 | TARGET_LANG | Call by reference | Type reference (TYPE) | LXEISOLANG | Translation Language | 20120314 | |||
| 5 | TTX | Value transfer | Type reference (TYPE) | XSTRING | 20120314 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Base class for XLIFF Translation exceptions | 20120314 |
Method GET_ZXLF_TEXTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | AREA | Call by reference | Type reference (TYPE) | LXECUSTMNR | Translation Area | 20120208 | |||
| 2 | LANGUAGE | Call by reference | Type reference (TYPE) | LXEISOLANG | Translation Language | 20120208 | |||
| 3 | OBJNAME | Call by reference | Type reference (TYPE) | LXEOBJNAME | Name of Translation Object | 20120208 | |||
| 4 | TEXTS | Value transfer | Type reference (TYPE) | LXE_TEXT_TAB | Text Lines | 20120208 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Base class for XLIFF Translation exceptions | 20120208 |
Method READ_SHORT_TEXT_PAIRS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | AREA | Call by reference | Type reference (TYPE) | LXECUSTMNR | Translation Area | 20101223 | |||
| 2 | OBJNAME | Call by reference | Type reference (TYPE) | LXEOBJNAME | Name of Translation Object | 20101223 | |||
| 3 | SHORT_TEXT_PAIRS | Call by reference | Type reference (TYPE) | LXE_TT_PCX_S1 | Short texts - table type | 20101223 | |||
| 4 | SOURCE_LANG | Call by reference | Type reference (TYPE) | LXEISOLANG | ISO Language ID | 20101223 | |||
| 5 | TARGET_LANG | Call by reference | Type reference (TYPE) | LXEISOLANG | ISO Language ID | 20101223 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Base class for XLIFF Translation exceptions | 20110124 |
Method SET_COMMENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | AREA | Call by reference | Type reference (TYPE) | LXECUSTMNR | Translation Area | 20110120 | |||
| 2 | COMMENT | Call by reference | Type reference (TYPE) | STRING | Translator's comment | 20110120 | |||
| 3 | OBJECT_NAME | Call by reference | Type reference (TYPE) | LXEOBJNAME | Name of Translation Object | 20110120 | |||
| 4 | OBJECT_TYPE | Call by reference | Type reference (TYPE) | LXEOBJTYPE | Type of Translation Object | 20110120 | |||
| 5 | TEXTKEY | Call by reference | Type reference (TYPE) | LXETEXTKEY | Text Key | 20110120 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Base class for XLIFF Translation exceptions | 20110124 |
Method SET_STEXT_THRESHOLD Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | AREA | Call by reference | Type reference (TYPE) | LXECUSTMNR | Translation Area | 20130613 | |||
| 2 | THRESHOLD | Call by reference | Type reference (TYPE) | LXEUNITMLT | Maximum Length of Translation Unit | 20130613 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Base class for XLIFF Translation exceptions | 20130613 |
Method WRITE_SHORT_TEXT_PAIRS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | AREA | Call by reference | Type reference (TYPE) | LXECUSTMNR | Translation Area | 20101227 | |||
| 2 | OBJNAME | Call by reference | Type reference (TYPE) | LXEOBJNAME | Name of Translation Object | 20101227 | |||
| 3 | SOURCE_LANG | Call by reference | Type reference (TYPE) | LXEISOLANG | ISO Language ID | 20101227 | |||
| 4 | TARGET_LANG | Call by reference | Type reference (TYPE) | LXEISOLANG | ISO Language ID | 20101227 | |||
| 5 | TEXT_PAIRS | Call by reference | Type reference (TYPE) | LXE_TT_PCX_S1 | Short texts - table type | 20101227 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Base class for XLIFF Translation exceptions | 20110124 |
History
| Last changed by/on | SAP | 20140121 |
| SAP Release Created in | 731 |