SAP ABAP Class CL_SRM_QUERY (Query Operations for Documents)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-RM (Application Component) SAP Records Management
     ⤷ SRM_GENERIC_SP (Package) Records Management Generic Service Provider

Properties

Class	CL_SRM_QUERY
Short Description	Query Operations for Documents
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status	P	SAP Standard Production Program
Category	0
Package	SRM_GENERIC_SP	Records Management Generic Service Provider
Created	20000425	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	CL_SRM_GENERIC_SP	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
2	CL_SRM_QUERY	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
3	SRMGS	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_SRM_QUERY has no interface implemented.

Friends

Class CL_SRM_QUERY has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	C_MAX_HITS	Constant	Private	☐	Type reference (TYPE)	I	10000		20020829
2	M_RMS_ID	Instance attribute	Private	☐	Type reference (TYPE)	STRING		RMS ID	20030729
3	M_SPS_ID	Instance attribute	Private	☐	Type reference (TYPE)	STRING		SPS ID	20030729
4	PROPERTY_VARIANT	Constant	Private	☐	Type reference (TYPE)	CHAR25	'SRM_VARIANT_ID'	Variant ID	20000717
5	PROPERTY_VERSION	Constant	Private	☐	Type reference (TYPE)	CHAR25	'SRM_VERSION_ID'	Version ID	20000717
6	PROP_RANGE_DOCUMENTS	Constant	Public	☐	Type reference (TYPE)	I	1	Use Properties from Documents	20010822
7	PROP_RANGE_VARIANTS	Constant	Public	☐	Type reference (TYPE)	I	2	Use Properties from Versions/Variants	20010822
8	REL_LOGOBJ	Constant	Private	☐	Type reference (TYPE)	SDOKRECL-RE_CLASS	'LOGOBJECT'	Document Class	20000718

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	COMBINED_QUERY	Static method	Public	Method	PHIO/LOIO Property Search and Full Text Search	20020829
2	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20030729
3	IS_UNIQUE	Static method	Public	Method	Checks Whether a Particular Property Value is Unique	20000831
4	PROPERTY_QUERY	Static method	Public	Method	Simple Property Search	20000717
5	P_FILTER_HITLIST2	Static method	Private	Method	Search Result Filter --- Filters Out Unwanted Results	20011107
6	SIMPLE_QUERY	Static method	Public	Method	Simple Property and Full Text Search	20011108

Events

Class CL_SRM_QUERY has no event.

Types

Class CL_SRM_QUERY has no local type.

Method Signatures

Method COMBINED_QUERY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CONTENTS_QUERY	Value transfer	☑	Type reference (TYPE)	SRMGS_CONT_QUERY_DESCR		Beschreibung der Volltextsuche	20020829
2	Importing	LANGUAGE	Call by reference	☐	Type reference (TYPE)	SRET_LAISO		Sprache	20020829
3	Importing	MAX_HITS	Call by reference	☐	Type reference (TYPE)	I		Maximale Trefferzahl, die geliefert werden soll	20020829
4	Importing	NEAR_BY	Call by reference	☐	Type reference (TYPE)	I	0	Abstand für Near-By Operator	20020829
5	Importing	ONLY_ACTUAL	Call by reference	☐	Type reference (TYPE)	SRMGS_BOOLEAN	SRMGS_TRUE	Nur Treffer in aktuellen Versionen zurückliefern?	20020829
6	Importing	PROPERTIES	Call by reference	☐	Type reference (TYPE)	SRMGS_PROPERTY_TAB		Liste der Eigenschaften, die zurückgeliefert werden soll	20020829
7	Importing	PROPERTY_QUERY	Value transfer	☐	Type reference (TYPE)	SRMGS_PROP_QUERY_DESCR		Beschreibung der Property-Suche	20020829
8	Exporting	RESULT_SET	Call by reference	☐	Object reference (TYPE REF TO)	CL_SRM_RESULTSET		Referenz auf Objekt mit Ergebnisliste	20020829
9	Importing	RMS_ID	Call by reference	☐	Type reference (TYPE)	SRMGS_RMS_ID		Records Management System	20020829
10	Importing	SPS_ID	Call by reference	☐	Type reference (TYPE)	SRMGS_SPS_ID		Elementart in der gesucht werden soll	20020829

#	Exception	Resumable	Description	Created on
1	INTERNAL_ERROR	☐	Ein interner Fehler trat auf.	20020829
2	NOT_AUTHORIZED	☐	Der Benutzer ist nicht autorisiert.	20020829
3	NO_SEARCH_ENGINE	☐	Suchmaschine läuft nicht	20020829
4	PARAMETER_ERROR	☐	Die Parameter waren falsch.	20020829
5	WRONG_SPS_CUSTOMIZING	☐	Das SPS Customizing ist fehlerhaft	20020829

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_RMS_ID	Call by reference	☐	Type reference (TYPE)	STRING			20030729
2	Importing	IM_SPS_ID	Call by reference	☐	Type reference (TYPE)	STRING			20030729

Method CONSTRUCTOR on class CL_SRM_QUERY has no exception.

Method IS_UNIQUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ONLY_ACTUAL	Call by reference	☐	Type reference (TYPE)	SRMGS_BOOLEAN	SRMGS_TRUE	Überprüfe nur aktuelle Dokumentversionen	20000831
2	Importing	PROPERTY_NAME	Call by reference	☐	Type reference (TYPE)	SRMGS_PROP_NAME		Name der Eigenschaft	20000831
3	Importing	PROPERTY_VALUE	Call by reference	☐	Type reference (TYPE)	SRMGS_PROP_VALUE		Zu pruefender Wert	20000831
4	Importing	RANGE	Call by reference	☐	Type reference (TYPE)	I	CL_SRM_QUERY=>PROP_RANGE_VARIANTS	Suchbereich: siehe Konstanten PROP_RANGE*	20000831
5	Importing	RMS_ID	Call by reference	☐	Type reference (TYPE)	SRMGS_RMS_ID		RMS in dem zu prüfen ist	20000831
6	Importing	SPS_ID	Call by reference	☐	Type reference (TYPE)	SRMGS_SPS_ID		Elementart in der zu prüfen ist	20000831

#	Exception	Resumable	Description	Created on
1	INTERNAL_ERROR	☐	Ein interner Fehler trat auf	20000831
2	NOT_AUTHORIZED	☐	Berechtigung zur Suche auf diesem Property fehlt	20000831
3	NOT_UNIQUE	☐	Der Eigenschaftswert ist nicht eindeutig	20000831
4	PARAMETER_ERROR	☐	Die Parameter waren falsch	20000831
5	WRONG_SPS_CUSTOMIZING	☐	Das SPS Customizing ist fehlerhaft	20001009

Method PROPERTY_QUERY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOCUMENT_CLASS	Call by reference	☑	Type reference (TYPE)	SRMGS_CLASS_NAME		Content-Modell (wird gebraucht, wenn Elementart nicht geg.)	20000804
2	Importing	MAX_HITS	Call by reference	☐	Type reference (TYPE)	I		Maximaltrefferzahl, die geliefert werden soll	20000717
3	Importing	ONLY_ACTUAL	Call by reference	☐	Type reference (TYPE)	SRMGS_BOOLEAN	SRMGS_TRUE	Nur in aktuellen Versionen suchen?	20000830
4	Importing	PROPERTIES	Call by reference	☐	Type reference (TYPE)	SRMGS_PROPERTY_TAB		Liste der zurückzuliefernden Eigenschaften	20000717
5	Importing	QUERY	Value transfer	☐	Type reference (TYPE)	SRMGS_PROP_QUERY_DESCR		Query-Beschreibung	20000717
6	Importing	RANGE	Call by reference	☐	Type reference (TYPE)	I	CL_SRM_QUERY=>PROP_RANGE_VARIANTS	In w. Eigenschaften soll gesucht werd. s. Konst. PROP_RANGE*	20000717
7	Exporting	RESULT_SET	Call by reference	☐	Object reference (TYPE REF TO)	CL_SRM_RESULTSET		Ergebnismenge als Objekt	20000717
8	Importing	RMS_ID	Call by reference	☐	Type reference (TYPE)	SRMGS_RMS_ID		RMS in dem gesucht werden soll	20000830
9	Importing	SPS_ID	Call by reference	☐	Type reference (TYPE)	SRMGS_SPS_ID		Elementart in der gesucht werden soll	20000717

#	Exception	Resumable	Description	Created on
1	INTERNAL_ERROR	☐	Ein interner Fehler trat auf.	20000717
2	NOT_AUTHORIZED	☐	Der Benutzer ist nicht autorisiert.	20000717
3	PARAMETER_ERROR	☐	Die Parameter waren falsch.	20000717
4	WRONG_SPS_CUSTOMIZING	☐	Das SPS Customizing ist fehlerhaft	20001009

Method P_FILTER_HITLIST2 Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	HIT_LIST	Call by reference	☐	Type reference (TYPE)	SRMGS_POID_TAB		Trefferliste	20011107
2	Importing	MAX_HITS	Call by reference	☐	Type reference (TYPE)	I		Maximale Trefferzahl	20011107
3	Importing	ONLY_ACTUAL	Call by reference	☐	Type reference (TYPE)	SRMGS_BOOLEAN		Liefere nur aktuelle Versionen	20011107
4	Importing	RMS_ID	Call by reference	☐	Type reference (TYPE)	SRMGS_RMS_ID		Treffer nur in diesem RMS	20011107
5	Importing	SPS_ID	Call by reference	☐	Type reference (TYPE)	SRMGS_SPS_ID		Treffer nur in dieser Elementart	20011107

Method P_FILTER_HITLIST2 on class CL_SRM_QUERY has no exception.

Method SIMPLE_QUERY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CONTENTS_QUERY	Call by reference	☐	Type reference (TYPE)	SRMGS_CONT_QUERY_DESCR		Beschreibung der Volltextsuche	20011108
2	Importing	LANGUAGE	Call by reference	☐	Type reference (TYPE)	SRET_LAISO		Sprache	20011108
3	Importing	MAX_HITS	Call by reference	☐	Type reference (TYPE)	I		Maximale Trefferzahl, die geliefert werden soll	20011108
4	Importing	NEAR_BY	Call by reference	☐	Type reference (TYPE)	I	0	Abstand für Near-By Operator	20011108
5	Importing	ONLY_ACTUAL	Call by reference	☐	Type reference (TYPE)	SRMGS_BOOLEAN	SRMGS_TRUE	Nur Treffer in aktuellen Versionen zurückliefern?	20011108
6	Importing	PROPERTIES	Call by reference	☐	Type reference (TYPE)	SRMGS_PROPERTY_TAB		Liste der Eigenschaften, die zurückgeliefert werden soll	20011108
7	Importing	PROPERTY_QUERY	Value transfer	☐	Type reference (TYPE)	SRMGS_PROP_QUERY_DESCR		Beschreibung der Property-Suche	20011108
8	Exporting	RESULT_SET	Call by reference	☐	Object reference (TYPE REF TO)	CL_SRM_RESULTSET		Referenz auf Objekt mit Ergebnisliste	20011108
9	Importing	RMS_ID	Call by reference	☐	Type reference (TYPE)	SRMGS_RMS_ID		Records Management System	20011108
10	Importing	SPS_ID	Call by reference	☐	Type reference (TYPE)	SRMGS_SPS_ID		Elementart in der gesucht werden soll	20011108

#	Exception	Resumable	Description	Created on
1	INTERNAL_ERROR	☐	Ein interner Fehler trat auf.	20011108
2	NOT_AUTHORIZED	☐	Der Benutzer ist nicht autorisiert.	20011108
3	NO_SEARCH_ENGINE	☐	Suchmaschine läuft nicht	20011108
4	PARAMETER_ERROR	☐	Die Parameter waren falsch.	20011108
5	WRONG_SPS_CUSTOMIZING	☐	Das SPS Customizing ist fehlerhaft	20011108

History

Last changed by/on	SAP	20110908
SAP Release Created in	46D