SAP ABAP Class CL_SRM_GENERIC_SP (Generic Service Provider RMS)

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

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_SRM_SP_CONNECTION	Abstract Basis Class for Connection	20010810
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SRM_AUTHORITY_CHECK	Authority check in the GSP	20070725
3	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SRM_CONNECTION	Reading Methods for Working with Repositories	20000608
4	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SRM_CONNECTION_NEW	Specific: For SP New Connection	20000811
5	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SRM_CONTEXT_AUTOMATION	SP: Context Automation	20011019
6	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SRM_GENERIC_SP	GSP 2: Interface for Document Connection	20030708
7	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SRM_GSP_IMPL	Generic SP Implementation	20031117
8	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SRM_GSP_POID_INFO	Get Information for POID Object	20010109
9	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SRM_NON_VISUAL_INFO_SP	SP Non-Visual Info for SP	20001031
10	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SRM_SP_ENQUEUE	Element Locks	20020725
...	Click here to see Used By full list (1 items)

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_RMPS_SP_POST_BACKEND	Obsolete: Back-End of Incoming Post Item	20020610

Properties

Class	CL_SRM_GENERIC_SP
Short Description	Generic Service Provider RMS
Super Class	CL_SRM_SP_CONNECTION	Abstract Basis Class for Connection
Instantiability of a Class	2	Public
Final	☐

General Data

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

Forward declarations

#	Type group / Object type	Type	Type Description
1	SRMGS	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
2	SRMGU	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
3	SRMIF	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_SRM_AUTHORITY_CHECK	☐	☐	Authority check in the GSP	20070725
2	IF_SRM_CONNECTION	☐	☐	Reading Methods for Working with Repositories	20000608
3	IF_SRM_CONNECTION_NEW	☐	☐	Specific: For SP New Connection	20000811
4	IF_SRM_CONTEXT_AUTOMATION	☐	☐	SP: Context Automation	20011019
5	IF_SRM_GENERIC_SP	☐	☐	GSP 2: Interface for Document Connection	20030708
6	IF_SRM_GSP_IMPL	☐	☐	Generic SP Implementation	20031117
7	IF_SRM_GSP_POID_INFO	☐	☐	Get Information for POID Object	20010109
8	IF_SRM_NON_VISUAL_INFO_SP	☐	☐	SP Non-Visual Info for SP	20001031
9	IF_SRM_SP_ENQUEUE	☐	☐	Element Locks	20020725
10	IF_SRM_SP_INFO	☐	☐	Informationen on Service Provider	20030702
11	IF_SRM_SP_SYSTEM_PARA	☐	☐	SP System Parameters	20000719
12	IF_SRM_VERSION_HELPER	☐	☐	Version Handling	20031230
13	IF_SRM_VERSION_INFO	☐	☐	Read Information on Element Versions	20011001

Friends

#	Friend	Modeled only	Created on	Description
1	CL_SRM_DOCUMENT	☐	20020812	Represents a Document
2	CL_SRM_GENERIC_SP0	☐	20031121	Generic Service Provider RMS

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	C_CONN_PARA_DOC_CLASS	Constant	Public	☐	Type reference (TYPE)	STRING	'DOCUMENT_CLASS'	Document Class Connection Parameters	20010810
2	C_CONT_PARA_PROPERTIES	Constant	Private	☐	Type reference (TYPE)	STRING	'DOC_PROPERTIES'	Context Parameter Name for Properties	20010820
3	MY_DOCUMENT	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_SRM_DOCUMENT		Used Document Object	20000608
4	MY_DOC_ID	Instance attribute	Protected	☐	Type reference (TYPE)	SRMGS_DOC_ID		Document ID	20000608
5	MY_POID	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_SRM_POID		POID Object Reference	20031202
6	MY_VARIANT	Instance attribute	Protected	☐	Type reference (TYPE)	SRMGS_DOC_VAR_ID		Variant Used	20010104
7	MY_VERSION	Instance attribute	Protected	☐	Type reference (TYPE)	SRMGS_DOC_VER_ID		Version Used	20010104
8	OMIT_AUTHORITY_CHECK	Static Attribute	Private	☐	Type reference (TYPE)	BOOLEAN	' '	Boolean Variable (X=true, -=false, space=unknown)	20070725
9	PROP_PDIR_ID	Constant	Public	☐	Type reference (TYPE)	SRMGS_PROP_NAME	'SRM_POID_ID'	Property Name: PDIR ID	20011023
10	PROP_RMS_ID	Constant	Public	☐	Type reference (TYPE)	SRMGS_PROP_NAME	'SRM_RMS_ID'	Property Name: RMS ID	20011023
11	PROP_SPS_ID	Constant	Public	☐	Type reference (TYPE)	SRMGS_PROP_NAME	'SRM_SPS_ID'	Property Name: SPS ID	20011023

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20031202
2	COPY_PARTIAL	Instance method	Public	Method	Only Copy One Version/Variant of Document	20010830
3	CREATE_DOCUMENT	Instance method	Public	Method	Create a Document (from New)	20000608
4	CREATE_SP_POID	Static method	Public	Method	Create an SP-POID for the Document Specified	20001214
5	GET_DOCUMENT	Instance method	Public	Method	Returns the Document Used by the SP	20000608
6	GET_DOC_CLASS	Static method	Public	Method	Get Document Class for an Element Type	20000818
7	GSPROPS_2_EDIT_ATT_VALUE	Instance method	Public	Method	Convert Attribute Values in Structure Form to Objects	20020722
8	P_ADD_INHERITED_PROPERTIES	Instance method	Protected	Method	Add Properties that are inherited between versions	20020812
9	P_CONNECT	Instance method	Protected	Method	Create Link to Document	20010115
10	P_CREATE	Instance method	Protected	Method	Create New DB Object and Link	20010115
11	P_CREATE_GUID	Instance method	Private	Method	Generate New GUID	20011018
12	P_FINISH_POID	Instance method	Private	Method	Create a POID: Model POID --> Instance POID	20010830
13	P_GET_CONNECTION_PARAMS	Instance method	Private	Method	Get Connection Parameter	20010831
14	P_GET_MY_POID_INFOS	Instance method	Protected	Method	Get Information From Own POID	20010831
15	P_SET_PDIR_ID	Instance method	Private	Method	Set POID Directory ID	20011018

Events

#	Event	Type	Visibility	Description	Created on
1	SRM_NO_PROPER_STATE	Instance Event (0)	Private (0)		20000608

Types

Class CL_SRM_GENERIC_SP has no local type.

Method Signatures

Method CONSTRUCTOR Signature

Method CONSTRUCTOR on class CL_SRM_GENERIC_SP has no parameter.
Method CONSTRUCTOR on class CL_SRM_GENERIC_SP has no exception.

Method COPY_PARTIAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOC_OBJECT_ID_OF_COPY	Value transfer	☑	Type reference (TYPE)	SRMGS_DOC_ID-OBJID		Vorgeschlagene ID der Kopie	20030429
2	Returning	POID	Value transfer	☐	Object reference (TYPE REF TO)	IF_SRM_POID		POID des neuen Dokumentes	20010830
3	Importing	PROPERTIES	Value transfer	☑	Type reference (TYPE)	SRMGS_PROPERTY_TAB		Zu ändernde Eigenschaften	20010831
4	Importing	VARIANT_ID	Value transfer	☐	Type reference (TYPE)	I	-1	Variantennummer	20010830
5	Importing	VERSION_ID	Value transfer	☐	Type reference (TYPE)	I	-1	Versionsnummer	20010830

#	Exception	Resumable	Description	Created on
1	SRM_DUPLICATE_OBJECT_ID	☐	Objekt ID der Kopie nicht eindeutig	20030429
2	SRM_NOT_AUTHORIZED	☐	Berechtigung fehlt	20010831
3	SRM_UNEXPECTED_ERROR	☐	Unerwarteter Fehler	20010831
4	SRM_VARIANT_NOT_FOUND	☐	Variante wurde nicht gefunden	20010831
5	SRM_VERSION_NOT_FOUND	☐	Version wurde nicht gefunden	20010831

Method CREATE_DOCUMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOCUMENT_ID	Value transfer	☑	Type reference (TYPE)	STRING		Eindeutiger Dokumentenname	20010111
2	Importing	DOC_OBJECT_ID	Value transfer	☑	Type reference (TYPE)	SRMGS_DOC_ID-OBJID		Interne Objekt ID zur Ident. des Dokumentes	20030414
3	Importing	DO_COMMIT	Value transfer	☐	Type reference (TYPE)	SRMGS_BOOLEAN	SRMGS_FALSE	'X': do commit	20030429
4	Importing	DO_UPDATE_TASK	Value transfer	☐	Type reference (TYPE)	SRMGS_BOOLEAN	SRMGS_FALSE	Anlegen in Verbuchung	20030429
5	Importing	PROPERTIES	Value transfer	☑	Type reference (TYPE)	SRMGS_PROPERTY_TAB		Eigenschaften, die beim Anlegen am Dok. gesetzt werd. sollen	20011023

#	Exception	Resumable	Description	Created on
1	SRM_BAD_POID	☐	POID nicht OK	20000608
2	SRM_CANT_SET_COMMIT_MODE	☐	Set-Commit-Mode fehlgeschlagen	20030429
3	SRM_DUPLICATE_OBJECT_ID	☐	Objekt ID nicht eindeutig	20030414
4	SRM_NOT_AUTHORIZED	☐	Nicht berechtigt zum Erzeugen	20000608
5	SRM_NO_PROPER_STATE	☐	Erzeugen ist in diesem Zustand nicht möglich	20000608
6	SRM_UNALLOWED_UPDATE_MODE	☐	Commit/Update mode unallowed	20030429
7	SRM_UNEXPECTED_ERROR	☐	Unerwarteter Fehler	20000608

Method CREATE_SP_POID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOC_ID	Value transfer	☐	Type reference (TYPE)	SRMGS_DOC_ID		Dokumenten-ID	20001214
2	Exporting	SP_POID	Call by reference	☐	Type reference (TYPE)	SRM_LIST_POID		SP-POID Tabelle	20001214
3	Importing	VARIANT	Value transfer	☐	Type reference (TYPE)	SRMGS_DOC_VAR_ID	0	Variante	20001214
4	Importing	VERSION	Value transfer	☐	Type reference (TYPE)	SRMGS_DOC_VER_ID	0	Version	20001214

Method CREATE_SP_POID on class CL_SRM_GENERIC_SP has no exception.

Method GET_DOCUMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	DOCUMENT	Call by reference	☐	Object reference (TYPE REF TO)	CL_SRM_DOCUMENT		Repräsentiert ein Dokument	20000608

#	Exception	Resumable	Description	Created on
1	NOT_CONNECTED	☐	Kein Dokument vorhanden	20000608

Method GET_DOC_CLASS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	DOC_CLASS	Call by reference	☐	Type reference (TYPE)	SRMGS_CLASS_NAME		Name der Dokuklasse	20000818
2	Importing	IF_SRM	Value transfer	☑	Object reference (TYPE REF TO)	IF_SRM		Allgemeine SRM Methoden	20020313
3	Importing	SPS_ID	Call by reference	☐	Type reference (TYPE)	SRMGS_SPS_ID		ID des Service Provider Space	20000818

#	Exception	Resumable	Description	Created on
1	INTERNAL_ERROR	☐	Ein interner Fehler ist aufgetreten	20000818
2	PARAMETER_ERROR	☐	Der SPS-ID ist keine Dokuklasse zugeordnet	20000818

Method GSPROPS_2_EDIT_ATT_VALUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EDIT_ATT_DESC_TAB	Call by reference	☐	Type reference (TYPE)	SRM_LIST_EDIT_ATTRIBUTE_DESC		Tabelle Attributbeschreibung als Objekt	20020722
2	Exporting	EDIT_ATT_VALUE_TAB	Call by reference	☐	Type reference (TYPE)	SRM_LIST_EDIT_ATTRIBUTE_VALUE		Tabelle Attributwerte als Objekt	20020722
3	Importing	PROP_TAB	Call by reference	☐	Type reference (TYPE)	SRMGS_PROPERTY_TAB		Tabelle Attributwerte als Struktur	20020722
4	Importing	PROP_TYPE_TAB	Call by reference	☐	Type reference (TYPE)	SRMGS_PROPERTY_TYPE_TAB		Tabelle Attributbeschreibung als Struktur	20020722

#	Exception	Resumable	Description	Created on
1	SRM_PROP_TYPE_NOT_FOUND	☐	Kein prop type gefunden für einen prop entry	20020722
2	SRM_UNEXPECTED_ERROR	☐	Unerwarteter Fehler	20020722

Method P_ADD_INHERITED_PROPERTIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	OLD_VARIANT	Value transfer	☐	Object reference (TYPE REF TO)	CL_SRM_VARIANT		Alte Variante, an der ggf. Properties geholt werden können	20020812
2	Changing	PROPERTIES	Call by reference	☐	Type reference (TYPE)	SRMGS_PROPERTY_TAB		Eigenschaften, die vererbt werden	20020812

#	Exception	Resumable	Description	Created on
1	INTERNAL_ERROR	☐		20021118
2	NOT_AUTHORIZED	☐		20021118
3	PARAMETER_ERROR	☐		20021118

Method P_CONNECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOC_ID	Call by reference	☐	Type reference (TYPE)	SRMGS_DOC_ID		Dokumenten-ID	20010115
2	Importing	VARIANT	Call by reference	☐	Type reference (TYPE)	SRMGS_DOC_VAR_ID		Variante	20010115
3	Importing	VERSION	Call by reference	☐	Type reference (TYPE)	SRMGS_DOC_VER_ID		Version	20010115

#	Exception	Resumable	Description	Created on
1	INTERNAL_ERROR	☐	Ein interner Fehler trat auf	20010115
2	NOT_AUTHORIZED	☐	Der Anwender ist nicht authorisiert	20010115
3	NOT_FOUND	☐	Objekt nicht gefunden	20010115
4	PARAMETER_ERROR	☐	Die Parameter waren falsch	20010115

Method P_CREATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOC_CLASS	Call by reference	☐	Type reference (TYPE)	SRMGS_CLASS_NAME		Dokumentenklasse	20010115
2	Importing	DOC_OBJECT_ID	Value transfer	☑	Type reference (TYPE)	SRMGS_DOC_ID-OBJID		Interne Objekt ID	20030414
3	Importing	DO_COMMIT	Value transfer	☐	Type reference (TYPE)	SRMGS_BOOLEAN	SRMGS_FALSE	'X': do commit	20030429
4	Importing	DO_UPDATE_TASK	Value transfer	☐	Type reference (TYPE)	SRMGS_BOOLEAN	SRMGS_FALSE	Anlegen in Verbuchung	20030429
5	Importing	PROPERTIES	Call by reference	☐	Type reference (TYPE)	SRMGS_PROPERTY_TAB		Eigenschaften	20010115

#	Exception	Resumable	Description	Created on
1	CANT_SET_COMMIT_MODE	☐	Ändern vom Commit-Modus fehlgeschlagen	20030429
2	DUPLICATE_OBJECT_ID	☐	Objekt ID nicht eindeutig	20030414
3	INTERNAL_ERROR	☐	Ein interner Fehler trat auf	20010115
4	NOT_AUTHORIZED	☐	Der Anwender ist nicht authorisiert	20010115
5	PARAMETER_ERROR	☐	Die Parameter waren falsch	20010115
6	UPDATE_TASK_NOT_POSSIBLE	☐	Verbuchung nicht unterstützt	20030429

Method P_CREATE_GUID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	GUID	Value transfer	☐	Type reference (TYPE)	STRING		Erstellte GUID	20011018

Method P_CREATE_GUID on class CL_SRM_GENERIC_SP has no exception.

Method P_FINISH_POID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOC_ID	Value transfer	☐	Type reference (TYPE)	SRMGS_DOC_ID		Document-ID	20010830
2	Importing	DO_UPDATE_TASK	Value transfer	☐	Type reference (TYPE)	SRMGS_BOOLEAN	SRMGS_FALSE	Update in Verbuchung	20030429
3	Returning	PDIR_ID	Value transfer	☐	Type reference (TYPE)	STRING		POID-Directory ID	20011018
4	Importing	POID	Value transfer	☐	Object reference (TYPE REF TO)	IF_SRM_POID		POID-Objekt	20010830

#	Exception	Resumable	Description	Created on
1	SRM_UNEXPECTED_ERROR	☐	Ein unerwarteter Fehler trat auf	20010830

Method P_GET_CONNECTION_PARAMS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	DOCUMENT_CLASS	Call by reference	☐	Type reference (TYPE)	STRING		Dokumenten-Klasse	20010831

#	Exception	Resumable	Description	Created on
1	SRM_UNEXPECTED_ERROR	☐	Unerwarteter Fehler	20010831

Method P_GET_MY_POID_INFOS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	POID	Value transfer	☐	Object reference (TYPE REF TO)	IF_SRM_POID		Referenz auf POID-Objekt	20010831
2	Exporting	RMS_ID	Value transfer	☐	Type reference (TYPE)	STRING		Records Management System	20010831
3	Exporting	SPS_ID	Value transfer	☐	Type reference (TYPE)	STRING		Elementart	20010831

#	Exception	Resumable	Description	Created on
1	SRM_BAD_POID	☐	Fehlerhafte POID	20010831
2	SRM_UNEXPECTED_ERROR	☐	Ein unerwarteter Fehler trat auf	20010831

Method P_SET_PDIR_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOC	Value transfer	☐	Object reference (TYPE REF TO)	CL_SRM_DOCUMENT		Dokument	20011018
2	Importing	PDIR_ID	Value transfer	☐	Type reference (TYPE)	STRING		POID-Directory ID	20011018

#	Exception	Resumable	Description	Created on
1	UNEXPECTED_ERROR	☐	Ein unerwarteter Fehler trat auf	20011018

Event Signatures

Event SRM_NO_PROPER_STATE Signature
Event SRM_NO_PROPER_STATE on class CL_SRM_GENERIC_SP has no parameter.

Meta Relationship - Using (full list)

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_SRM_SP_CONNECTION	Abstract Basis Class for Connection	20010810
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SRM_AUTHORITY_CHECK	Authority check in the GSP	20070725
3	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SRM_CONNECTION	Reading Methods for Working with Repositories	20000608
4	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SRM_CONNECTION_NEW	Specific: For SP New Connection	20000811
5	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SRM_CONTEXT_AUTOMATION	SP: Context Automation	20011019
6	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SRM_GENERIC_SP	GSP 2: Interface for Document Connection	20030708
7	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SRM_GSP_IMPL	Generic SP Implementation	20031117
8	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SRM_GSP_POID_INFO	Get Information for POID Object	20010109
9	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SRM_NON_VISUAL_INFO_SP	SP Non-Visual Info for SP	20001031
10	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SRM_SP_ENQUEUE	Element Locks	20020725
11	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SRM_SP_INFO	Informationen on Service Provider	20030702
12	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SRM_SP_SYSTEM_PARA	SP System Parameters	20000719
13	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SRM_VERSION_HELPER	Version Handling	20031230
14	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SRM_VERSION_INFO	Read Information on Element Versions	20011001

History

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