SAP ABAP Class CL_SRM_DOCUMENT (Represents a Document)

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_LOG_INFOOBJECT	Base Class for Logical Information Objects	20000608
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SRM_DOCUMENT	GSP 2: Interface Document	20030708
3	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SRM_PROTOCOL	Logging Operations	20000726

Properties

Class	CL_SRM_DOCUMENT
Short Description	Represents a Document
Super Class	CL_SRM_LOG_INFOOBJECT	Base Class for Logical Information Objects
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	20000420	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

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

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_SRM_DOCUMENT	☐	☐	GSP 2: Interface Document	20030708
2	IF_SRM_PROTOCOL	☐	☐	Logging Operations	20000726

Friends

#	Friend	Modeled only	Created on	Description
1	CL_SRM_GENERIC_SP	☐	20001025	Generic Service Provider RMS
2	CL_SRM_INFOOBJECT	☐	20001121	Base Class for Information Objects
3	CL_SRM_PHYS_INFOOBJECT	☐	20011023	Physical Information Object
4	CL_SRM_QUERY	☐	20001024	Query Operations for Documents
5	CL_SRM_VERSION	☐	20001116	Version of a Document

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	ACT_CREATE	Constant	Public	☐	Type reference (TYPE)	SRMGS_ACTIVITY	'CREATE'	Activity: Creating Documents	20011116
2	ACT_DELETE	Constant	Public	☐	Type reference (TYPE)	SRMGS_ACTIVITY	'DELETE'	Activity: Delete	20030821
3	ACT_MODIFY	Constant	Public	☐	Type reference (TYPE)	SRMGS_ACTIVITY	'MODIFY'	Activity: Write Access for Content	20010822
4	ACT_MODIFY_PROPERTIES	Constant	Public	☐	Type reference (TYPE)	SRMGS_ACTIVITY	'MODIFY_PROPS'	Change Properties	20040706
5	ACT_SEARCH	Constant	Public	☐	Type reference (TYPE)	SRMGS_ACTIVITY	'SEARCH'	Activity: Find Document	20010822
6	ACT_VIEW	Constant	Public	☐	Type reference (TYPE)	SRMGS_ACTIVITY	'VIEW'	Activity: Read Access to Content	20010822
7	C_MAX_VERSION_NAME	Constant	Private	☐	Type reference (TYPE)	SRMGS_PROP_NAME	'SRM_MAX_VERSION'	Name of Property for Maximum Version Number of Document	20010830
8	LOCK_IS_SET	Instance attribute	Private	☐	Type reference (TYPE)	SRMGS_BOOLEAN		Shows that the Document is Locked	20010103
9	MY_ACT_VARIANT	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_SRM_VARIANT		Last Variant Accessed	20040130
10	MY_ACT_VARIANT_VAR_ID	Instance attribute	Private	☐	Type reference (TYPE)	SRMGS_DOC_VAR_ID			20040130
11	MY_ACT_VARIANT_VER_ID	Instance attribute	Private	☐	Type reference (TYPE)	SRMGS_DOC_VER_ID			20040130
12	MY_ACT_VERSION	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_SRM_VERSION		Last Accessed Version of a Document	20050414
13	MY_CACHE_SRMGSPRNAM	Instance attribute	Private	☐	See coding				20011016
14	MY_CHILDREN	Instance attribute	Protected	☐	Type reference (TYPE)	SRMGS_CHLD_OBJECT_TAB		Info on Children Cache	20020729
15	MY_CHLD_FORCE_RELOAD	Instance attribute	Protected	☐	Type reference (TYPE)	SRMGS_BOOLEAN		Enforce a Reload With Next Access of Children	20020729
16	MY_CONT_TYPE	Instance attribute	Private	☐	Type reference (TYPE)	C		Content Type of the Content Model ...	20001115
17	MY_DB_MODE_CNTRL	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_SRM_KPRO_DBMODE_CTRL		Reference to the Administration Instance of the DB Op. Mode	20050504
18	MY_DEL_CANDIDATE	Instance attribute	Private	☐	Type reference (TYPE)	I		Candidate for Version Deletion	20011022
19	MY_DOC_EXIT	Static Attribute	Private	☐	Object reference (TYPE REF TO)	IF_EX_SRMGS_DOCUMENT		Document BADI	20040308
20	MY_DOC_EXIT_LOADED	Static Attribute	Private	☐	Type reference (TYPE)	SRMGS_BOOLEAN	SRMGS_FALSE	Has the BADI already been loaded?	20040308
21	MY_DO_COMMIT	Instance attribute	Private	☐	Type reference (TYPE)	SRMGS_BOOLEAN	SRMGS_TRUE	Execute Commit?	20020423
22	MY_DO_UPDATE_TASK	Instance attribute	Private	☐	Type reference (TYPE)	SRMGS_BOOLEAN	SRMGS_FALSE	Execute change in update?	20030408
23	MY_INTERM_DELETION_IS_ON	Instance attribute	Private	☐	Type reference (TYPE)	SRMGS_BOOLEAN		Activity: Find Document	20011023
24	MY_PHIOCLASS	Instance attribute	Private	☐	Type reference (TYPE)	SRMGS_CLASS_NAME		IO class for Versions and Variants	20001115
25	MY_PROTOCOL_ACTIVE	Instance attribute	Private	☐	Type reference (TYPE)	SRMGS_BOOLEAN		Logging Active?	20011016
26	MY_SPS_ID	Instance attribute	Private	☐	Type reference (TYPE)	SRMGS_SPS_ID		Element Type ID	20040630
27	MY_STORAGE_TYPE	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20050729
28	MY_USAGE_FRAMEWORK	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_SRM_GENERIC_SP		Optional: Usage Framework	20020812
29	MY_VARIANT_ID	Instance attribute	Private	☐	Type reference (TYPE)	SRMGS_DOC_VAR_ID		Pre-Defined Variant ID	20000503
30	MY_VERSION_ID	Instance attribute	Private	☐	Type reference (TYPE)	SRMGS_DOC_VER_ID		Pre-Defined Version ID	20000503
31	POID_INFO_HANDLER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_SRM_GSP_POID_INFO		Logging: Obtaining Information Using POIDs	20010109
32	PROP_CONTENT_CHANGED_AT	Constant	Public	☐	Type reference (TYPE)	SRMGS_PROP_NAME	'LAST_CHANGED_AT'	Property Name: Content Last Changed On	20011026
33	PROP_CONTENT_CHANGED_BY	Constant	Public	☐	Type reference (TYPE)	SRMGS_PROP_NAME	'LAST_CHANGED_BY'	Property Name: Content Last Changed By	20011026
34	PROP_CREATED_AT	Constant	Public	☐	Type reference (TYPE)	SRMGS_PROP_NAME	'CREATED_AT'	Property Name: Created On	20011026
35	PROP_CREATED_BY	Constant	Public	☐	Type reference (TYPE)	SRMGS_PROP_NAME	'CREATED_BY'	Property Name: Created By	20011026
36	PROP_DESCRIPTION	Constant	Public	☐	Type reference (TYPE)	SRMGS_PROP_NAME	'DESCRIPTION'	Property Name: Description Text	20011023
37	PROP_DOCUMENT_ID	Constant	Public	☐	Type reference (TYPE)	SRMGS_PROP_NAME	'SRM_DOCUMENT_ID'	Property Name: Unique Identification	20011023
38	PROP_DOC_STATE	Constant	Public	☐	Type reference (TYPE)	SRMGS_PROP_NAME	'SRM_DOCUMENT_STATE'	Property Name: Document Status	20011026
39	PROP_FILEPLAN_POS	Constant	Public	☐	Type reference (TYPE)	SRMGS_PROP_NAME	'SRM_FILEPLAN_POS'	Property Name: Position in File Plan	20011026
40	PROP_IS_TRANSPORTED	Constant	Public	☐	Type reference (TYPE)	SRMGS_PROP_NAME	'SRM_IS_TRANSPORTED'	Property Name: Document is Transported	20011026
41	PROP_KEYWORD	Constant	Public	☐	Type reference (TYPE)	SRMGS_PROP_NAME	'SRM_KEYWORD'	Property Name: Keyword Catalog	20020805
42	PROP_LOGICAL_VERSION	Constant	Public	☐	Type reference (TYPE)	SRMGS_PROP_NAME	'SRM_LOG_VERSION'	Property Name for Logical Version Number	20011022
43	PROP_MODEL	Constant	Public	☐	Type reference (TYPE)	SRMGS_PROP_NAME	'SRM_MODEL'	Property Name: ID of Model From Which Document Originates	20011023
44	PROP_MODEL_DOCID	Constant	Public	☐	Type reference (TYPE)	SRMGS_PROP_NAME	'SRM_MODEL_DOCID'	Property Name: Technical ID of Model	20030429
45	PROP_PHYSICAL_VARIANT	Constant	Public	☐	Type reference (TYPE)	SRMGS_PROP_NAME	'SRM_VARIANT_ID'	Property Name: Physical Variant ID	20011023
46	PROP_PHYSICAL_VERSION	Constant	Public	☐	Type reference (TYPE)	SRMGS_PROP_NAME	'SRM_VERSION_ID'	Property Name: Physical Version Number	20011023
47	PROP_PROPS_CHANGED_AT	Constant	Public	☐	Type reference (TYPE)	SRMGS_PROP_NAME	'SRM_LAST_CHANGED_AT'	Property Name: Properties Last Changed On	20011026
48	PROP_PROPS_CHANGED_BY	Constant	Public	☐	Type reference (TYPE)	SRMGS_PROP_NAME	'SRM_LAST_CHANGED_BY'	Property Name: Properties Last Changed By	20011026

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	APPLY_LOCK	Instance method	Public	Method	Create Lock for this Document	20001005
2	CONNECT	Instance method	Protected	Method	Link to an Existing DB Instance	20000502
3	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20000428
4	COPY	Instance method	Public	Method	Copy Complete Document	20000703
5	COPY_PARTIAL	Instance method	Public	Method	Copy Document --- But Only With One Version/Variant	20000717
6	CREATE	Instance method	Protected	Method	Create New Document DB Instance	20000428
7	CREATE_VERSION	Instance method	Public	Method	Create New Version of Document	20000505
8	DBG_RELATION_INFO	Instance method	Public	Method	Get Information on Internal Relations of a Document	20000728
9	DELETE	Instance method	Public	Method	Delete Document	20000508
10	FREEZE_CURRENT_VERSION	Instance method	Public	Method	Freeze Current Version	20011025
11	GET_SPS_ID	Instance method	Public	Method	Request Element Type ID	20040630
12	GET_TRANSPORT_INFOS	Instance method	Public	Method	Get Transport Infos for Whole Document	20001103
13	GET_VARIANT	Instance method	Public	Method	Get Variant of the Document	20000503
14	GET_VERSION	Instance method	Public	Method	Get a Version of the Document	20000502
15	GET_VERSIONS_INFO	Instance method	Public	Method	Get Information on All Versions of a Document	20000502
16	GET_VERSION_NO	Instance method	Public	Method	Get Version Number	20011026
17	IS_AUTHORIZED	Instance method	Public	Method	Checks Whether User is Authorised for Particular Activities	20001130
18	IS_AUTHORIZED_DOC	Static method	Public	Method	Authorization Check Without Instance	20011116
19	IS_MODIFIABLE	Instance method	Public	Method	Checks Whether Document May Be Modified (is locked or not)	20010110
20	NEW_VARIANT	Instance method	Public	Method	Create New Version with New Variant	20010315
21	P_AFTER_VERSION_CREATE	Instance method	Private	Method	Call After Creating New Version	20011023
22	P_CREATE_VARIANT	Instance method	Protected	Method	Create a New Version Object	20020722
23	P_CREATE_VERSION	Instance method	Protected	Method	Create a New Version Object	20001011
24	RECONNECT	Instance method	Private	Method	Change Connection - Only For Internal Use	20011108
25	REMOVE_LOCK	Instance method	Public	Method	Delete Lock for the Document	20001005
26	SET_COMMIT_MODE	Instance method	Public	Method	Set Commit Mode	20020423
27	SET_SPS_ID	Instance method	Public	Method	Set Element Type ID	20040630
28	SET_UPDATE_MODE	Instance method	Public	Method	Set Update Mode	20030408
29	WRITE_PROTO_NAME	Instance method	Private	Method	Write Name Under a Key for Log	20011016

Events

Class CL_SRM_DOCUMENT has no event.

Types

Class CL_SRM_DOCUMENT has no local type.

Method Signatures

Method APPLY_LOCK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	LOCK_USER	Call by reference	☐	Type reference (TYPE)	STRING		Anwender, der den Lock hält	20001005

#	Exception	Resumable	Description	Created on
1	INTERNAL_ERROR	☐	Ein interner Fehler trat auf	20001005
2	NOT_AUTHORIZED	☐	Der Anwender ist nicht authorisiert	20001011
3	YET_LOCKED	☐	Das Dokument ist bereits gelockt	20001005

Method 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		ID des Dokoments	20000502
2	Importing	VARIANT	Call by reference	☑	Type reference (TYPE)	SRMGS_DOC_VAR_ID		ID der Variante	20000502
3	Importing	VERSION	Call by reference	☑	Type reference (TYPE)	SRMGS_DOC_VER_ID		ID der Version	20000502

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

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CREATE	Call by reference	☐	Type reference (TYPE)	SRMGS_BOOLEAN	' '	Soll ein neues Dokument erzeugt werden?	20000608
2	Importing	DOC_CLASS	Call by reference	☑	Type reference (TYPE)	SRMGS_CLASS_NAME		Dokumentenklasse für Dokumente	20000615
3	Importing	DOC_ID	Call by reference	☑	Type reference (TYPE)	SRMGS_DOC_ID		ID des Dokuments	20000608
4	Importing	DO_COMMIT	Call by reference	☐	Type reference (TYPE)	SRMGS_BOOLEAN	SRMGS_FALSE	Commit Ja/Nein	20020423
5	Importing	DO_UPDATE_TASK	Call by reference	☐	Type reference (TYPE)	SRMGS_BOOLEAN	SRMGS_FALSE	'X': update in Verbuchung	20030414
6	Importing	OMIT_AUTHORITY_CHECK	Call by reference	☐	Type reference (TYPE)	SRMGS_BOOLEAN	SRMGS_FALSE	Authority-Check (nicht-)durchführen	20070725
7	Importing	PROPERTIES	Call by reference	☑	Type reference (TYPE)	SRMGS_PROPERTY_TAB		Properties für das neue Dokument	20000608
8	Importing	SPS_ID	Call by reference	☑	Type reference (TYPE)	SRMGS_SPS_ID		Elementart-ID des Dokumentes	20040630
9	Importing	USAGE_FRAMEWORK	Call by reference	☑	Object reference (TYPE REF TO)	CL_SRM_GENERIC_SP		Generischer Service Provider RMS	20020812
10	Importing	VARIANT	Call by reference	☑	Type reference (TYPE)	SRMGS_DOC_VAR_ID		ID der Variante	20000608
11	Importing	VERSION	Call by reference	☑	Type reference (TYPE)	SRMGS_DOC_VER_ID		ID der Version	20000608

#	Exception	Resumable	Description	Created on
1	CANT_SET_COMMIT_MODE	☐	Commit.-Modus konnte nicht wie gewuenscht gesetzt werden	20020423
2	DUPLICATE_OBJECT_ID	☐	Doc ID existiert, Anlegen mit dieser ID unmöglich	20030414
3	INTERNAL_ERROR	☐	Ein interner Fehler trat auf	20000608
4	NOT_AUTHORIZED	☐	Der Anwender ist nicht authorisiert	20000608
5	NOT_FOUND	☐	Objekt nicht gefunden	20000616
6	PARAMETER_ERROR	☐	Die Parameter waren falsch	20000608
7	UPDATE_TASK_NOT_POSSIBLE	☐	Änderung in Verbuchung nicht möglich	20030414

Method COPY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	NEW_DOCUMENT	Call by reference	☐	Type reference (TYPE)	SRMGS_DOC_INFO			20000703
2	Importing	NEW_DOC_ID	Value transfer	☑	Type reference (TYPE)	SRMGS_DOC_ID			20030428

#	Exception	Resumable	Description	Created on
1	DUPLICATE_OBJECT_ID	☐	Doc ID existiert, Kopieren nach dieser ID unmöglich	20030429
2	INTERNAL_ERROR	☐	Ein interner Fehler trat auf	20000703
3	NOT_AUTHORIZED	☐	Der Anwender ist nicht authorisiert	20000703

Method COPY_PARTIAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	APPL_PROPS	Call by reference	☑	Type reference (TYPE)	SRMGS_PROPERTY_TAB		Zu ändernder Applikationseigenschaften	20010831
2	Exporting	NEW_DOCUMENT	Call by reference	☐	Type reference (TYPE)	SRMGS_DOC_INFO		ID des neuen Dokumentes	20000717
3	Importing	NEW_DOC_ID	Value transfer	☑	Type reference (TYPE)	SRMGS_DOC_ID		ID des neuen Dokumentes	20030428
4	Importing	TECH_PROPS	Call by reference	☑	Type reference (TYPE)	SRMGS_PROPERTY_TAB		Neue (technische) Dokumenteigenschaften	20010831
5	Importing	VARIANT_ID	Call by reference	☐	Type reference (TYPE)	SRMGS_DOC_VAR_ID	-1	Variante	20010830
6	Importing	VERSION_ID	Call by reference	☐	Type reference (TYPE)	SRMGS_DOC_VER_ID	-1	Version	20010830

#	Exception	Resumable	Description	Created on
1	DUPLICATE_OBJECT_ID	☐	Doc ID existiert, Kopieren nach dieser ID unmöglich	20030429
2	INTERNAL_ERROR	☐	Ein interner Fehler trat auf	20000717
3	NOT_AUTHORIZED	☐	Der Anwender ist nicht authorisiert	20000717
4	VARIANT_NOT_FOUND	☐	Variante wurde nicht gefunden	20010829
5	VERSION_NOT_FOUND	☐	Version wurde nicht gefunden	20010829

Method 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 für Dokumente	20000615
2	Importing	PROPERTIES	Call by reference	☑	Type reference (TYPE)	SRMGS_PROPERTY_TAB		Properties für das neue Dokument	20000503

#	Exception	Resumable	Description	Created on
1	DUPLICATE_OBJECT_ID	☐	Doc ID existiert, Anlegen mit dieser ID unmöglich	20030414
2	INTERNAL_ERROR	☐	Ein interner Fehler trat auf	20000502
3	NOT_AUTHORIZED	☐	Der Anwender ist nicht authorisiert	20000502
4	PARAMETER_ERROR	☐	Die Parameter waren falsch	20000502

Method CREATE_VERSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CREATE_NEW_LOG_VERSION	Value transfer	☐	Type reference (TYPE)	SRMGS_BOOLEAN	SRMGS_FALSE	Neue logische Version anlegen?	20011022
2	Importing	IM_IS_NEW_DOC	Value transfer	☑	Type reference (TYPE)	SRMGS_BOOLEAN			20080821
3	Exporting	NEW_VERSION	Call by reference	☐	Object reference (TYPE REF TO)	CL_SRM_VERSION		Die neue Version	20000505
4	Importing	OLD_VERSION_ID	Value transfer	☐	Type reference (TYPE)	SRMGS_DOC_VER_ID	ACTUAL_VERSION	DUMMY: Version, von der diese Version abgezweigt werden soll	20000505
5	Importing	PROPERTIES	Call by reference	☑	Type reference (TYPE)	SRMGS_PROPERTY_TAB		Properties der neuen Version.	20000505

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

Method DBG_RELATION_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	INFO	Call by reference	☐	Type reference (TYPE)	SRMGS_DBG_RELA_TAB		Infos zu Beziehungen	20000728

Method DBG_RELATION_INFO on class CL_SRM_DOCUMENT has no exception.

Method DELETE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NO_CHECK	Value transfer	☑	Type reference (TYPE)	SRMGS_BOOLEAN		Berechtigung nicht prüfen	20050207

#	Exception	Resumable	Description	Created on
1	INTERNAL_ERROR	☐	Ein interner Fehler trat auf	20000508
2	NOT_AUTHORIZED	☐	Benutzer ist nicht authorisiert	20000508
3	NOT_POSSIBLE	☐	Loeschen wg. Konsistenzbedingungen nicht möglich	20000508

Method FREEZE_CURRENT_VERSION Signature

Method FREEZE_CURRENT_VERSION on class CL_SRM_DOCUMENT has no parameter.

#	Exception	Resumable	Description	Created on
1	INTERNAL_ERROR	☐	interner Fehler	20030218
2	NOT_AUTHORIZED	☐	keine Berechtigung	20030218

Method GET_SPS_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	SPS_ID	Value transfer	☐	Type reference (TYPE)	SRMGS_SPS_ID			20040630

Method GET_SPS_ID on class CL_SRM_DOCUMENT has no exception.

Method GET_TRANSPORT_INFOS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	TRANSPORT_INFOS	Call by reference	☐	Type reference (TYPE)	SRMGS_COMMFILE_ENTRY_TAB		Tabelle mit Transportinformationen	20001103
2	Exporting	TRANSPORT_INFOS2	Call by reference	☐	Type reference (TYPE)	SRMGS_COMMFILE_ENTRY_TAB2		Zusatzinfos zum Transport	20011029

#	Exception	Resumable	Description	Created on
1	CM_NOT_TRANSPORTABLE	☐	Das Content-Modell ist nicht transportierbar	20010423
2	INTERNAL_ERROR	☐	Ein interner Fehler trat auf.	20001103
3	NOT_AUTHORIZED	☐	Der Benutzer ist nicht autorisiert, das Objekt zu transp.	20001103

Method GET_VARIANT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_IS_NEW_DOC	Value transfer	☑	Type reference (TYPE)	SRMGS_BOOLEAN			20080821
2	Returning	MY_VARIANT	Value transfer	☐	Object reference (TYPE REF TO)	CL_SRM_VARIANT		Variante	20000503
3	Importing	TARGET_TIME	Call by reference	☑	Type reference (TYPE)	TIMESTAMP		Stichzeitpunkt	20000503
4	Importing	VARIANT_ID	Call by reference	☐	Type reference (TYPE)	SRMGS_DOC_VAR_ID	PRESET_VALUE	ID der Variante	20000503
5	Importing	VERSION_ID	Call by reference	☐	Type reference (TYPE)	SRMGS_DOC_VER_ID	PRESET_VALUE	ID der Version	20000503

#	Exception	Resumable	Description	Created on
1	INTERNAL_ERROR	☐	Ein interner Fehler trat auf	20000503
2	PARAMETER_ERROR	☐	Die Parameter waren falsch	20000623
3	VARIANT_NOT_FOUND	☐	Variante nicht gefunden	20000503
4	VERSION_NOT_FOUND	☐	Version nicht gefunden	20000503

Method GET_VERSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_IS_NEW_DOC	Value transfer	☑	Type reference (TYPE)	SRMGS_BOOLEAN			20080821
2	Importing	TARGET_TIME	Call by reference	☑	Type reference (TYPE)	TIMESTAMP		Stichzeitpunkt	20000502
3	Returning	VERSION	Value transfer	☐	Object reference (TYPE REF TO)	CL_SRM_VERSION		Version	20000502
4	Importing	VERSION_ID	Call by reference	☐	Type reference (TYPE)	SRMGS_DOC_VER_ID	PRESET_VALUE	Versionsnummer	20000502

#	Exception	Resumable	Description	Created on
1	INTERNAL_ERROR	☐	Ein interner Fehler trat auf	20000502
2	NOT_FOUND	☐	Version nicht gefunden	20000613
3	PARAMETER_ERROR	☐	Die Parameter waren falsch	20000502

Method GET_VERSIONS_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PROPERTIES	Call by reference	☐	Type reference (TYPE)	SRMGS_PROPERTY_TAB		Gewünschte Properties	20000502
2	Exporting	VERSIONS	Call by reference	☐	Type reference (TYPE)	SRMGS_OBJECT_TAB		Liste der Objekt-Properties	20000502

#	Exception	Resumable	Description	Created on
1	INTERNAL_ERROR	☐	Ein interner Fehler trat auf	20000502
2	NOT_AUTHORIZED	☐	Der Anwender ist nicht authorisiert	20000609
3	PARAMETER_ERROR	☐	Die Parameter waren falsch	20000609

Method GET_VERSION_NO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	LOGICAL_VERSION	Value transfer	☐	Type reference (TYPE)	I		Ergebnis	20011026
2	Importing	PHYSICAL_VERSION	Value transfer	☐	Type reference (TYPE)	I	PRESET_VALUE	Physikalische Version für die die log. Version gesucht wird	20011026

Method GET_VERSION_NO on class CL_SRM_DOCUMENT has no exception.

Method IS_AUTHORIZED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ACTIVITY	Value transfer	☐	Type reference (TYPE)	SRMGS_ACTIVITY		Aktivität : Konstanten SRMGS_ACT*	20001130
2	Returning	OK	Value transfer	☐	Type reference (TYPE)	SRMGS_BOOLEAN		Authorisation vorhanden?	20001130

Method IS_AUTHORIZED on class CL_SRM_DOCUMENT has no exception.

Method IS_AUTHORIZED_DOC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ACTIVITY	Value transfer	☐	Type reference (TYPE)	SRMGS_ACTIVITY		Aktivität (CL_SRM_DOCUMENT=>ACT_...)	20011116
2	Returning	OK	Value transfer	☐	Type reference (TYPE)	SRMGS_BOOLEAN		True wenn Berechtigung vorhanden	20011116
3	Importing	SPS_ID	Value transfer	☐	Type reference (TYPE)	STRING		SPS ID	20011116

Method IS_AUTHORIZED_DOC on class CL_SRM_DOCUMENT has no exception.

Method IS_MODIFIABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	OPERATION	Call by reference	☐	Type reference (TYPE)	STRING		Operation, die durchgeführt werden soll	20010110
2	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	SRMGS_BOOLEAN		Ergebnis	20010110

Method IS_MODIFIABLE on class CL_SRM_DOCUMENT has no exception.

Method NEW_VARIANT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CREATE_NEW_LOG_VERSION	Value transfer	☐	Type reference (TYPE)	SRMGS_BOOLEAN	SRMGS_FALSE	Neue logische Version anlegen?	20011022
2	Importing	IM_IS_NEW_DOC	Value transfer	☑	Type reference (TYPE)	SRMGS_BOOLEAN			20080821
3	Returning	NEW_VARIANT	Value transfer	☐	Object reference (TYPE REF TO)	CL_SRM_VARIANT		Neue Variante	20010315
4	Importing	OLD_VARIANT_ID	Value transfer	☐	Type reference (TYPE)	I	PRESET_VALUE	Alte Variante, von der diese abgeleitet	20010315
5	Importing	PROPERTIES	Value transfer	☑	Type reference (TYPE)	SRMGS_PROPERTY_TAB		Eigenschaften	20010315

#	Exception	Resumable	Description	Created on
1	INTERNAL_ERROR	☐	internal error	20010315
2	NOT_AUTHORIZED	☐	authorization failure -- check user authorizations	20010315
3	NOT_POSSIBLE	☐	Action not allowed -- eg: when content type is 2	20010315
4	PARAMETER_ERROR	☐	input parameters are wrong	20010315

Method P_AFTER_VERSION_CREATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CALLER	Value transfer	☐	Object reference (TYPE REF TO)	CL_SRM_PHYS_INFOOBJECT		Physikalisches Informationsobjekt	20011023

Method P_AFTER_VERSION_CREATE on class CL_SRM_DOCUMENT has no exception.

Method P_CREATE_VARIANT 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		Dok-ID der Version	20020722
2	Returning	OBJECT	Value transfer	☐	Object reference (TYPE REF TO)	CL_SRM_VARIANT		Erzeugtes Objekt	20020722
3	Importing	VARIANT_ID	Call by reference	☐	Type reference (TYPE)	I			20020722
4	Importing	VERSION_ID	Call by reference	☐	Type reference (TYPE)	I			20020722

Method P_CREATE_VARIANT on class CL_SRM_DOCUMENT has no exception.

Method P_CREATE_VERSION 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		Dok-ID der Version	20001011
2	Returning	OBJECT	Value transfer	☐	Object reference (TYPE REF TO)	CL_SRM_VERSION		Erzeugtes Objekt	20001011
3	Importing	VARIANT_ID	Call by reference	☐	Type reference (TYPE)	I			20020716
4	Importing	VERSION_ID	Call by reference	☐	Type reference (TYPE)	I			20020716

Method P_CREATE_VERSION on class CL_SRM_DOCUMENT has no exception.

Method RECONNECT 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		Neues Dokument	20011108

Method RECONNECT on class CL_SRM_DOCUMENT has no exception.

Method REMOVE_LOCK Signature

Method REMOVE_LOCK on class CL_SRM_DOCUMENT has no parameter.
Method REMOVE_LOCK on class CL_SRM_DOCUMENT has no exception.

Method SET_COMMIT_MODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DO_COMMIT	Call by reference	☐	Type reference (TYPE)	SRMGS_BOOLEAN		Commit Ja/Nein	20020423

#	Exception	Resumable	Description	Created on
1	MODE_NOT_CHANGED	☐	Commit.-Modus konnte nicht deaktiviert werden	20020423
2	NOT_POSSIBLE	☐	Commit Ja unerlaubt fallsin Verbuchung geändert werden soll	20030428

Method SET_SPS_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	SPS_ID	Call by reference	☐	Type reference (TYPE)	SRMGS_SPS_ID		Elementart-ID des Dokumentes	20040630

Method SET_SPS_ID on class CL_SRM_DOCUMENT has no exception.

Method SET_UPDATE_MODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DO_UPDATE_TASK	Value transfer	☐	Type reference (TYPE)	SRMGS_BOOLEAN	SRMGS_FALSE		20030408

#	Exception	Resumable	Description	Created on
1	INTERNAL_ERROR	☐		20030408
2	NOT_POSSIBLE	☐		20030408

Method WRITE_PROTO_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	KEY	Value transfer	☐	Type reference (TYPE)	STRING		Schlüssel	20011016
2	Importing	NAME	Value transfer	☐	Type reference (TYPE)	STRING		Name	20011016

Method WRITE_PROTO_NAME on class CL_SRM_DOCUMENT has no exception.

History

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