SAP ABAP Class CL_DOC_CLASS (Document Class)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-KPR-RET (Application Component) Text Retrieval and Information Extraction
     ⤷ SRET_DEMO (Package) Retrieval Demonstration

Properties

Class	CL_DOC_CLASS
Short Description	Document Class
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SRET_DEMO	Retrieval Demonstration
Created	20000425	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_DOC_CLASS has no forward declaration.

Interfaces

Class CL_DOC_CLASS has no interface implemented.

Friends

Class CL_DOC_CLASS has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	DOC_CLASS_HIERARCHY	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_DOC_CLASS_HIERARCHY		Document Class Hierarchy	20000428
2	INDEX	Instance attribute	Private	☐	Type reference (TYPE)	SRET_DBCNT		Index	20000425
3	NAME	Instance attribute	Private	☐	Type reference (TYPE)	SRET_ATRVL		Name	20000425
4	SEARCH_INDEX	Instance attribute	Private	☐	Type reference (TYPE)	SRET_CATID		Search Index	20000426

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECKIN_DOC	Instance method	Public	Method	Check in Document	20000530
2	CHECKIN_DOC_X	Instance method	Public	Method	Check in Document	20000910
3	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20000425
4	CREATE_NEW_SUBCLASS	Instance method	Public	Method	Create New Subclass	20000621
5	DELETE_WEB_CRAWLING_RESULTS	Instance method	Public	Method	Delete Web Crawling Results	20000914
6	GET_DOCUMENTS	Instance method	Public	Method	Get Documents	20000425
7	GET_FEATURES	Instance method	Public	Method	Get Features	20000425
8	GET_INDEX	Instance method	Public	Method	Get Index	20000425
9	GET_NAME	Instance method	Public	Method	Get Name	20000425
10	GET_WEB_CRAWLING_RESULTS	Instance method	Public	Method	Get Web Crawling Results	20000425
11	START_WEB_CRAWLING	Instance method	Public	Method	Start Web Crawling as Background Job	20000425

Events

Class CL_DOC_CLASS has no event.

Types

Class CL_DOC_CLASS has no local type.

Method Signatures

Method CHECKIN_DOC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CWORDS	Call by reference	☐	Type reference (TYPE)	SRETFEAT_TAB		Schlagwoerter, die dazukommen	20000630
2	Importing	I_DESCRIPTION	Call by reference	☐	Type reference (TYPE)	STRING		Description des Dokuments	20000623
3	Importing	I_DOC_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Name des Dokuments	20000530
4	Importing	I_URL	Call by reference	☐	Type reference (TYPE)	STRING		URL des Dokuments	20000530

#	Exception	Resumable	Description	Created on
1	INTERNAL_ERROR	☐	Interner Fehler	20000530

Method CHECKIN_DOC_X Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_XML	Call by reference	☐	Type reference (TYPE)	STRING		Name des Dokuments	20000910

#	Exception	Resumable	Description	Created on
1	INTERNAL_ERROR	☐	Interner Fehler	20000910

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_DOC_CLASS_HIERARCHY	Call by reference	☐	Object reference (TYPE REF TO)	CL_DOC_CLASS_HIERARCHY		Hierarchie der Dokumentenklassen	20000428
2	Importing	I_INDEX	Call by reference	☐	Type reference (TYPE)	SRET_DBCNT		Index	20000425
3	Importing	I_NAME	Call by reference	☐	Type reference (TYPE)	SRET_ATRVL		Name der Dokumentenklasse	20000425
4	Importing	I_SEARCH_INDEX	Call by reference	☐	Type reference (TYPE)	SRET_CATID		Suchindex	20000426

Method CONSTRUCTOR on class CL_DOC_CLASS has no exception.

Method CREATE_NEW_SUBCLASS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CLASS_NAME	Call by reference	☐	Type reference (TYPE)	SRETCLASS-CLASS		Neue Subklasse, die eingefuegt werden soll	20000621

Method CREATE_NEW_SUBCLASS on class CL_DOC_CLASS has no exception.

Method DELETE_WEB_CRAWLING_RESULTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_DELETED_ENTRIES	Call by reference	☐	Type reference (TYPE)	I		Anzahl gelöschter Einträge	20000914

#	Exception	Resumable	Description	Created on
1	ENQUEUE_ERROR	☐	Enqueue Fehler	20000914

Method GET_DOCUMENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_DOCUMENTS	Call by reference	☐	Type reference (TYPE)	SRETSRES_TAB		Dokumente	20000919
2	Importing	I_BEGIN	Call by reference	☐	Type reference (TYPE)	I	0	Beginn	20000426
3	Importing	I_END	Call by reference	☐	Type reference (TYPE)	I	100	Ende	20000426
4	Importing	I_WITH_ADDITIONAL_INFO	Call by reference	☐	Type reference (TYPE)	CHAR01	' '	Mit Zusatzinfo	20000919

#	Exception	Resumable	Description	Created on
1	INTERNAL_ERROR	☐	Interner Fehler	20000426

Method GET_FEATURES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_FEATURES	Call by reference	☐	Type reference (TYPE)	SRETFEAT_TAB		Merkmale	20000426

#	Exception	Resumable	Description	Created on
1	INTERNAL_ERROR	☐	Interner Fehler	20000426

Method GET_INDEX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_INDEX	Call by reference	☐	Type reference (TYPE)	SRET_DBCNT		Index	20000425

Method GET_INDEX on class CL_DOC_CLASS has no exception.

Method GET_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_NAME	Call by reference	☐	Type reference (TYPE)	SRET_ATRVL		Name der Klasse	20000425

Method GET_NAME on class CL_DOC_CLASS has no exception.

Method GET_WEB_CRAWLING_RESULTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_NUMBER_OF_RUNNING_JOBS	Call by reference	☐	Type reference (TYPE)	I		Anzahl laufender Jobs	20000428
2	Exporting	E_RESULTS	Call by reference	☐	Type reference (TYPE)	SRETCLCRWL_TAB		WebCrawling Ergebnisse	20000428
3	Importing	I_FROM	Call by reference	☐	Type reference (TYPE)	I	0	Ergebnisse von...	20000428
4	Importing	I_TO	Call by reference	☐	Type reference (TYPE)	I	100	Ergebnisse bis...	20000428

Method GET_WEB_CRAWLING_RESULTS on class CL_DOC_CLASS has no exception.

Method START_WEB_CRAWLING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_FEATURES	Call by reference	☐	Type reference (TYPE)	SRETFEAT_TAB		Merkmale	20000428
2	Importing	I_LINKDEPTH	Call by reference	☐	Type reference (TYPE)	I		Linktiefe	20000428
3	Importing	I_SEARCH_ENGINES	Call by reference	☐	Type reference (TYPE)	SRETSELI_TAB		Suchmaschinen	20000428
4	Importing	I_STARTPAGES	Call by reference	☐	Type reference (TYPE)	SRETSTPA_TAB		Startseiten	20000428

#	Exception	Resumable	Description	Created on
1	INTERNAL_ERROR	☐	Interner Fehler	20000428

History

Last changed by/on	SAP	20110908
SAP Release Created in	50A