SAP ABAP Interface IF_ALINK_QUERY (ArchiveLink: Query Interface)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-ARL (Application Component) ArchiveLink
     ⤷ SAOP (Package) ArchiveLink general

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	CL_ALINK_QUERY	ArchiveLink: Query Classe External Sys	20001205
2	Interface implementation (CLASS c. INTERFACES i_ref)	CL_ALINK_QUERY_KPR	SAP ArchiveLink: KPro Query Class	20001205
3	Interface implementation (CLASS c. INTERFACES i_ref)	CL_DOCF_BDS_QUERY	SAP ArchiveLink: KPro Query Class	20021002
4	Interface implementation (CLASS c. INTERFACES i_ref)	CL_DOCF_KPRO_QUERY	SAP ArchiveLink: KPro Query Class	20020308
5	Interface implementation (CLASS c. INTERFACES i_ref)	CL_DOCF_PHIO_QUERY	SAP ArchiveLink: KPro Query Class	20020930
6	Interface implementation (CLASS c. INTERFACES i_ref)	CL_FVD_QUERY_CORR	Query Class: CML Outgoing Documents	20030227

Properties

Interface	IF_ALINK_QUERY
Short Description	ArchiveLink: Query Interface

General Data

Package	SAOP	ArchiveLink general
Created	20001205	SAP
Last changed	00000000	SAP
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	AKCL	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Interface IF_ALINK_QUERY has no interface.

Friends

Interface IF_ALINK_QUERY has no friend.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	ATTRIBUTES	Instance attribute	Public	☐	Type reference (TYPE)	TOARSATR_T		Attributes	20001205
2	CLIENT	Instance attribute	Public	☐	Type reference (TYPE)	SY-MANDT		Client	20001205
3	DOCUMENT_ATTRIBUTES	Instance attribute	Public	☐	Type reference (TYPE)	TOAATTR_T		Attribute definitions	20001205
4	HITLIST	Instance attribute	Public	☐	Type reference (TYPE)	TOARSDOC_T		Hit list	20001205

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	DISPLAY_HITLIST_CONTROL	Instance method	Public	Method	Carry Out Hit List Display in Control	20001205
2	EXPORT_TO_RM	Instance method	Public	Method	Export to Record	20010108
3	FREE_HITLIST_CONTROL	Instance method	Public	Method	Release Hit List Display Tool	20001205
4	GENERATE_QUERYMASK	Instance method	Public	Method	Generate Search Query Template for Attributes	20001205
5	GET_ATTRIBUTES	Instance method	Public	Method	Return Attributes for Hit	20001205
6	GET_DOCUMENT_ATTRIBUTES	Instance method	Public	Method	Return Definition of Document Attributes	20001205
7	GET_HITLIST	Instance method	Public	Method	Return Hit List Together with Attributes	20001205
8	GET_SUBDIRECTORY_HITLIST	Instance method	Public	Method	Return Hit List Behind Hit	20001205
9	GET_URL	Instance method	Public	Method	Return URL for Displaying a Hit	20010108
10	INITIALIZE	Instance method	Public	Method	Actual Constructor of Classes	20001205
11	IS_FTS_ACTIVE	Instance method	Public	Method	Full Text Search Possible	20001205
12	PERFORM_SEARCH	Instance method	Public	Method	Execute Search Query To Search Engines	20001205
13	SET_IMAGE_CONTAINER	Instance method	Public	Method	Set Container for Screen Display if Inplace Implemented	20011030

Events

Interface IF_ALINK_QUERY has no event.

Types

Interface IF_ALINK_QUERY has no local type.

Method Signatures

Method DISPLAY_HITLIST_CONTROL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_CONTAINER	Call by reference	☐	Object reference (TYPE REF TO)	CL_GUI_CONTAINER		Container ID des Anzeigetools	20001205

#	Exception	Resumable	Description	Created on
1	DISPLAY_FAILED	☐	Anzeige fehlgeschlagen	20001205

Method EXPORT_TO_RM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_RM_OBJECTS	Call by reference	☐	Type reference (TYPE)	TOARMOBJ_T		Tabelle von RM Objekten	20010108

#	Exception	Resumable	Description	Created on
1	NO_SELECTION	☐	Keine Selektion vorhanden	20010108
2	TOO_MANY_SELECTIONS	☐	Zu viele Selektionen	20010108

Method FREE_HITLIST_CONTROL Signature

Method FREE_HITLIST_CONTROL on Interface IF_ALINK_QUERY has no parameter.

#	Exception	Resumable	Description	Created on
1	FREE_FAILED	☐	Freigeben fehlgeschlagen	20001205

Method GENERATE_QUERYMASK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_REPID	Call by reference	☐	Type reference (TYPE)	SY-REPID		Report ID	20001205
2	Importing	IM_SUBDYNNR	Call by reference	☐	Type reference (TYPE)	SY-DYNNR		Subdynpronummer	20001205

#	Exception	Resumable	Description	Created on
1	EXTERNAL_ERROR	☐	Error im externen System	20001205
2	GENERATION_FAILED	☐	Generierung ist fehlgeschlagen	20001205
3	NO_ATTRIBUTES	☐	Keine Attribute im Dokumentenbereich verfügbar	20001205

Method GET_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_ATTRIBUTES	Call by reference	☐	Type reference (TYPE)	TOARSATR_T		Attributtrefferliste	20001205
2	Importing	IM_HIT	Call by reference	☐	Type reference (TYPE)	TOARSDOC_S		Dokumenttreffer	20001205

#	Exception	Resumable	Description	Created on
1	NO_ATTRIBUTES	☐	Keine Attribute	20001205

Method GET_DOCUMENT_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_DOCUMENT_ATTRIBUTES	Call by reference	☐	Type reference (TYPE)	TOAATTR_T		Dokumentattribute	20001205

#	Exception	Resumable	Description	Created on
1	NO_ATTRIBUTES_DEFINED	☐	Keine Attribute definiert	20001205

Method GET_HITLIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_ATTRIBUTES	Call by reference	☐	Type reference (TYPE)	TOARSATR_T		Attribute (optional)	20001205
2	Exporting	EX_HITLIST	Call by reference	☐	Type reference (TYPE)	TOARSDOC_T		Trefferliste	20001205

Method GET_HITLIST on Interface IF_ALINK_QUERY has no exception.

Method GET_SUBDIRECTORY_HITLIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_ATTRIBUTES	Call by reference	☐	Type reference (TYPE)	TOARSATR_T		Attribute (optional)	20001205
2	Exporting	EX_HITLIST	Call by reference	☐	Type reference (TYPE)	TOARSDOC_T		Dokumenttrefferliste	20001205
3	Importing	IM_HIT	Call by reference	☐	Type reference (TYPE)	TOARSDOC_S		Dokumenttreffer	20001205

#	Exception	Resumable	Description	Created on
1	NO_HITS	☐	Keine Treffer	20001205

Method GET_URL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_URL	Call by reference	☐	Type reference (TYPE)	TOAURL_T		Tabelle von Comid/URL	20010108
2	Importing	IM_HIT	Call by reference	☐	Type reference (TYPE)	TOARSDOC_S		Dokumenttrefferliste	20010108

#	Exception	Resumable	Description	Created on
1	NO_URL_AVAILABLE	☐	Keine URL verfügbar	20010108

Method INITIALIZE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_CALLBACK_FUNCTION	Call by reference	☑	Type reference (TYPE)	RS38L_FNAM		Callback FUB für die Querymask	20001205
2	Importing	IM_CLIENT	Call by reference	☑	Type reference (TYPE)	SY-MANDT		Mandant	20001205
3	Importing	IM_DOCUSPACETAB	Call by reference	☑	Type reference (TYPE)	TOADOCSP_T		Dokumentenbereich	20001205

#	Exception	Resumable	Description	Created on
1	INITIALIZATION_ERROR	☐	Fehler bei Initialisierung	20001205

Method IS_FTS_ACTIVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_STATUS	Call by reference	☐	Type reference (TYPE)	I		'0' = mind. eine FTS aktiv, -1 = keine aktiv	20001205

Method IS_FTS_ACTIVE on Interface IF_ALINK_QUERY has no exception.

Method PERFORM_SEARCH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_QUERY	Call by reference	☐	Object reference (TYPE REF TO)	CL_ALINK_KPRO_QUERY_CONVERSION		Konvertierungsservice für Query Formate	20001205

#	Exception	Resumable	Description	Created on
1	BAD_QUERY	☐	Fehlerhafte Anfrage	20001205
2	DOCUSPACE_UNKNOWN	☐	Dokumentbereich unbekannt	20001205
3	EXTERNAL_ERROR	☐	Error im Archivsystem	20001205
4	INITIALIZATION_ERROR	☐	Error Initialisierung	20001205
5	NO_HITS	☐	Keine Treffer	20001212

Method SET_IMAGE_CONTAINER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_CONTAINER	Call by reference	☐	Object reference (TYPE REF TO)	CL_GUI_CONTAINER		Abstracter Container fuer GUI Controls	20011030

Method SET_IMAGE_CONTAINER on Interface IF_ALINK_QUERY has no exception.

History

Last changed by/on	SAP	00000000
SAP Release Created in	610