SAP ABAP Class CL_TMAS_RFC_API (TM Analysis Service RFC API)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-DOC-TTL (Application Component) Translation Tools
     ⤷ SLXE_TMAS (Package) Translation Memory Analysis Service

Properties

Class	CL_TMAS_RFC_API
Short Description	TM Analysis Service RFC API
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status
Category	0
Package	SLXE_TMAS	Translation Memory Analysis Service
Created	20111017	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_TMAS_RFC_API has no interface implemented.

Friends

Class CL_TMAS_RFC_API has no friend class.

Attributes

Class CL_TMAS_RFC_API has no attribute.

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ACK_DOCS_T2007	Static method	Public	Method	Acknowledges that documents have been received	20120430
2	APPEND_CATRESULT	Static method	Private	Method		20111025
3	DRAW_DOCS7	Static method	Private	Method		20120430
4	EXTRACT_USER_STRINGS	Static method	Private	Method		20111021
5	EXTRACT_USER_XSTRINGS	Static method	Private	Method		20111021
6	GET_DOCUMENTS_T2007	Static method	Public	Method	Retrieves documents for analysis	20111021
7	GET_QUEUE_COUNTERS	Static method	Public	Method	Returns the analysis queue counters	20111017
8	INSTANTIATE_ACCESSOR	Static method	Private	Method		20111025
9	MARK_AS_FETCHED7	Static method	Private	Method		20120430
10	MARK_AS_FETCHING7	Static method	Private	Method		20120430
11	MOVE_TO_ERROR_RESULTS7	Static method	Private	Method		20120430
12	PUT_RESULTS_T2007	Static method	Public	Method	Puts analysis results	20111025
13	VERIFY_FILE_EXT	Static method	Private	Method		20130620
14	VERIFY_INI_FILE	Static method	Private	Method		20130620
15	VERIFY_OLD_TTX	Static method	Private	Method		20130620
16	VERIFY_SLCID	Static method	Private	Method		20130620
17	VERIFY_SOURCE_TEXT	Static method	Private	Method		20130620
18	VERIFY_TLCID	Static method	Private	Method		20130620
19	VERIFY_TM_HOST	Static method	Private	Method		20130620
20	VERIFY_TM_MEMORY	Static method	Private	Method		20130620
21	VERIFY_TM_PASSWORD	Static method	Private	Method		20130620
22	VERIFY_TM_SETTINGS	Static method	Private	Method		20130620
23	VERIFY_TM_USER	Static method	Private	Method		20130620
24	VERIFY_TTX	Static method	Private	Method		20130620

Events

Class CL_TMAS_RFC_API has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	T_RT2007	Private	See coding			20111025	t_rt2007 TYPE STANDARD TABLE OF tmas_d_rt2007 WITH DEFAULT KEY
2	T_UDSD	Private	See coding			20111021	t_udsd TYPE STANDARD TABLE OF tmas_d_udsd WITH DEFAULT KEY
3	T_UDXD	Private	See coding			20111021	t_udxd TYPE STANDARD TABLE OF tmas_d_udxd WITH DEFAULT KEY

Method Signatures

Method ACK_DOCS_T2007 Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOCIDS	Call by reference	☐	Type reference (TYPE)	TMAS_T_DOCID		Table of document ids	20120430

#	Exception	Resumable	Description	Created on
1	CX_TMAS_LOCK	☐	Table lock could not be obtained	20120430

Method APPEND_CATRESULT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CAT	Call by reference	☐	Type reference (TYPE)	TMAS_T2007_CAT		SDL Trados 2007 analysis category	20111025
2	Importing	CATRESULT	Call by reference	☐	Type reference (TYPE)	TMAS_S_CATRESULT_T2007		Analysis category results of Trados 2007	20111025
3	Importing	DOCID	Call by reference	☐	Type reference (TYPE)	TMAS_DOCID		Document ID	20111025
4	Importing	JOBID	Call by reference	☐	Type reference (TYPE)	TMAS_JOBID		Job ID	20111025
5	Changing	RT2007	Call by reference	☐	Type reference (TYPE)	T_RT2007			20111025

Method APPEND_CATRESULT on class CL_TMAS_RFC_API has no exception.

Method DRAW_DOCS7 Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	COUNT	Call by reference	☐	Type reference (TYPE)	I			20120430
2	Returning	DOCIDS	Value transfer	☐	Type reference (TYPE)	TMAS_T_DOCID		Table of document ids	20120430
3	Importing	JOBID	Call by reference	☐	Type reference (TYPE)	TMAS_JOBID		Job id	20120430
4	Importing	TMHOST	Call by reference	☐	Type reference (TYPE)	TMAS_STRING		String	20120430
5	Importing	TMMEM	Call by reference	☐	Type reference (TYPE)	TMAS_STRING		String	20120430
6	Importing	TMUSER	Call by reference	☐	Type reference (TYPE)	TMAS_STRING		String	20120430

#	Exception	Resumable	Description	Created on
1	CX_TMAS_LOCK	☐	Table lock could not be obtained	20120430

Method EXTRACT_USER_STRINGS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOCID	Call by reference	☐	Type reference (TYPE)	TMAS_DOCID		Document ID	20111021
2	Returning	STRING_TAB	Value transfer	☐	Type reference (TYPE)	TMAS_T_KEYSTRING		Table of key/string pairs	20111021
3	Importing	UDSD	Call by reference	☐	Type reference (TYPE)	T_UDSD			20111021

Method EXTRACT_USER_STRINGS on class CL_TMAS_RFC_API has no exception.

Method EXTRACT_USER_XSTRINGS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOCID	Call by reference	☐	Type reference (TYPE)	TMAS_DOCID		Document ID	20111021
2	Importing	UDXD	Call by reference	☐	Type reference (TYPE)	T_UDXD			20111021
3	Returning	XSTRING_TAB	Value transfer	☐	Type reference (TYPE)	TMAS_T_KEYXSTRING		Table of key/xstring pairs	20111021

Method EXTRACT_USER_XSTRINGS on class CL_TMAS_RFC_API has no exception.

Method GET_DOCUMENTS_T2007 Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	COUNT	Call by reference	☐	Type reference (TYPE)	I			20111021
2	Exporting	DOCUMENTS	Call by reference	☐	Type reference (TYPE)	TMAS_T_DOC_T2007		Table of documents for analysis with Trados 2007	20111021
3	Importing	JOBID	Call by reference	☑	Type reference (TYPE)	TMAS_JOBID		Job id	20120430
4	Importing	TMHOST	Call by reference	☑	Type reference (TYPE)	TMAS_STRING		String	20120430
5	Importing	TMMEM	Call by reference	☑	Type reference (TYPE)	TMAS_STRING		String	20120430
6	Importing	TMUSER	Call by reference	☑	Type reference (TYPE)	TMAS_STRING		String	20120430

#	Exception	Resumable	Description	Created on
1	CX_TMAS_LOCK	☐	Table lock could not be obtained	20111021

Method GET_QUEUE_COUNTERS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	COUNTERS_T2007	Call by reference	☐	Type reference (TYPE)	TMAS_T_QUEUE_COUNTER_T2007		Analysis queue counters	20120430

#	Exception	Resumable	Description	Created on
1	CX_TMAS_LOCK	☐	Table lock could not be obtained	20111017

Method INSTANTIATE_ACCESSOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ACCESSOR	Value transfer	☐	Object reference (TYPE REF TO)	IF_TMAS_ACCESSOR_T2007		Accessor interface for document properties	20111025
2	Importing	CLASSNAME	Call by reference	☐	Type reference (TYPE)	ABAP_ABSTYPENAME			20111025

#	Exception	Resumable	Description	Created on
1	CX_TMAS_ACCESSOR_INVALID	☐	Invalid accessor class	20111102

Method MARK_AS_FETCHED7 Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOCID	Call by reference	☐	Type reference (TYPE)	TMAS_DOCID		Document ID	20120430
2	Returning	MARKED	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20120430

#	Exception	Resumable	Description	Created on
1	CX_TMAS_LOCK	☐	Table lock could not be obtained	20120430

Method MARK_AS_FETCHING7 Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOCID	Call by reference	☐	Type reference (TYPE)	TMAS_DOCID		Document ID	20120430
2	Returning	MARKED	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20120430

#	Exception	Resumable	Description	Created on
1	CX_TMAS_LOCK	☐	Table lock could not be obtained	20120430

Method MOVE_TO_ERROR_RESULTS7 Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOCID	Call by reference	☐	Type reference (TYPE)	TMAS_DOCID		Document ID	20120430
2	Importing	ERROR	Call by reference	☐	Type reference (TYPE)	TMAS_S_ERROR		Analysis error	20120430
3	Importing	JOBID	Call by reference	☐	Type reference (TYPE)	TMAS_JOBID		Job ID	20120430

#	Exception	Resumable	Description	Created on
1	CX_TMAS_LOCK	☐	Table lock could not be obtained	20120430

Method PUT_RESULTS_T2007 Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	RESULTS	Call by reference	☐	Type reference (TYPE)	TMAS_T_RESULT_T2007		Table of Trados 2007 analysis results	20111025

#	Exception	Resumable	Description	Created on
1	CX_TMAS_LOCK	☐	Table lock could not be obtained	20111026

Method VERIFY_FILE_EXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FILE_EXT	Call by reference	☐	Type reference (TYPE)	TMAS_STRING		String	20130620

#	Exception	Resumable	Description	Created on
1	CX_TMAS_ACCESSOR_INVALID_DATA	☐	Accessor returned invalid data	20130620

Method VERIFY_INI_FILE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	INI_FILE	Call by reference	☐	Type reference (TYPE)	TMAS_XSTRING		XString	20130620

#	Exception	Resumable	Description	Created on
1	CX_TMAS_ACCESSOR_INVALID_DATA	☐	Accessor returned invalid data	20130620

Method VERIFY_OLD_TTX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	OLD_TTX	Call by reference	☐	Type reference (TYPE)	TMAS_XSTRING		XString	20130620

#	Exception	Resumable	Description	Created on
1	CX_TMAS_ACCESSOR_INVALID_DATA	☐	Accessor returned invalid data	20130620

Method VERIFY_SLCID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	SLCID	Call by reference	☐	Type reference (TYPE)	LXETMWARELCID		Locale ID	20130620

#	Exception	Resumable	Description	Created on
1	CX_TMAS_ACCESSOR_INVALID_DATA	☐	Accessor returned invalid data	20130620

Method VERIFY_SOURCE_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	SOURCE_TEXT	Call by reference	☐	Type reference (TYPE)	TMAS_XSTRING		XString	20130620

#	Exception	Resumable	Description	Created on
1	CX_TMAS_ACCESSOR_INVALID_DATA	☐	Accessor returned invalid data	20130620

Method VERIFY_TLCID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	TLCID	Call by reference	☐	Type reference (TYPE)	LXETMWARELCID		Locale ID	20130620

#	Exception	Resumable	Description	Created on
1	CX_TMAS_ACCESSOR_INVALID_DATA	☐	Accessor returned invalid data	20130620

Method VERIFY_TM_HOST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	TM_HOST	Call by reference	☐	Type reference (TYPE)	TMAS_STRING		String	20130620

#	Exception	Resumable	Description	Created on
1	CX_TMAS_ACCESSOR_INVALID_DATA	☐	Accessor returned invalid data	20130620

Method VERIFY_TM_MEMORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	TM_MEMORY	Call by reference	☐	Type reference (TYPE)	TMAS_STRING		String	20130620

#	Exception	Resumable	Description	Created on
1	CX_TMAS_ACCESSOR_INVALID_DATA	☐	Accessor returned invalid data	20130620

Method VERIFY_TM_PASSWORD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	TM_PASSWORD	Call by reference	☐	Type reference (TYPE)	TMAS_STRING		String	20130620

#	Exception	Resumable	Description	Created on
1	CX_TMAS_ACCESSOR_INVALID_DATA	☐	Accessor returned invalid data	20130620

Method VERIFY_TM_SETTINGS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	TM_SETTINGS	Call by reference	☐	Type reference (TYPE)	TMAS_STRING		String	20130620

#	Exception	Resumable	Description	Created on
1	CX_TMAS_ACCESSOR_INVALID_DATA	☐	Accessor returned invalid data	20130620

Method VERIFY_TM_USER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	TM_USER	Call by reference	☐	Type reference (TYPE)	TMAS_STRING		String	20130620

#	Exception	Resumable	Description	Created on
1	CX_TMAS_ACCESSOR_INVALID_DATA	☐	Accessor returned invalid data	20130620

Method VERIFY_TTX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	TTX	Call by reference	☐	Type reference (TYPE)	TMAS_XSTRING		XString	20130620

#	Exception	Resumable	Description	Created on
1	CX_TMAS_ACCESSOR_INVALID_DATA	☐	Accessor returned invalid data	20130620

History

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