Skip to content

/AWS1/CL_TEXADAPTER

An adapter selected for use when analyzing documents. Contains an adapter ID and a version number. Contains information on pages selected for analysis when analyzing documents asychronously.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_adapterid TYPE /AWS1/TEXADAPTERID /AWS1/TEXADAPTERID

A unique identifier for the adapter resource.

iv_version TYPE /AWS1/TEXADAPTERVERSION /AWS1/TEXADAPTERVERSION

A string that identifies the version of the adapter.

Optional arguments:

it_pages TYPE /AWS1/CL_TEXADAPTERPAGES_W=>TT_ADAPTERPAGES TT_ADAPTERPAGES

Pages is a parameter that the user inputs to specify which pages to apply an adapter to. The following is a list of rules for using this parameter.

  • If a page is not specified, it is set to ["1"] by default.

  • The following characters are allowed in the parameter's string: 0 1 2 3 4 5 6 7 8 9 - . No whitespace is allowed.

  • When using * to indicate all pages, it must be the only element in the list.

  • You can use page intervals, such as ["1-3", "1-1", "4-"]. Where * indicates last page of document.

  • Specified pages must be greater than 0 and less than or equal to the number of pages in the document.

Queryable Attributes

AdapterId

A unique identifier for the adapter resource.

Accessible with the following methods

Method Description
GET_ADAPTERID() Getter for ADAPTERID, with configurable default
ASK_ADAPTERID() Getter for ADAPTERID w/ exceptions if field has no value
HAS_ADAPTERID() Determine if ADAPTERID has a value

Pages

Pages is a parameter that the user inputs to specify which pages to apply an adapter to. The following is a list of rules for using this parameter.

  • If a page is not specified, it is set to ["1"] by default.

  • The following characters are allowed in the parameter's string: 0 1 2 3 4 5 6 7 8 9 - . No whitespace is allowed.

  • When using * to indicate all pages, it must be the only element in the list.

  • You can use page intervals, such as ["1-3", "1-1", "4-"]. Where * indicates last page of document.

  • Specified pages must be greater than 0 and less than or equal to the number of pages in the document.

Accessible with the following methods

Method Description
GET_PAGES() Getter for PAGES, with configurable default
ASK_PAGES() Getter for PAGES w/ exceptions if field has no value
HAS_PAGES() Determine if PAGES has a value

Version

A string that identifies the version of the adapter.

Accessible with the following methods

Method Description
GET_VERSION() Getter for VERSION, with configurable default
ASK_VERSION() Getter for VERSION w/ exceptions if field has no value
HAS_VERSION() Determine if VERSION has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_ADAPTERS

TYPES TT_ADAPTERS TYPE STANDARD TABLE OF REF TO /AWS1/CL_TEXADAPTER WITH DEFAULT KEY
.