SAP ABAP Interface IF_SRM_SP_DOCUMENT (Document API)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-RM (Application Component) SAP Records Management
     ⤷ SRM_GENERAL_SP (Package) SRM General SPs

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	CL_SRM_SP_DOCUMENT	Represents SP Document	20030902

Properties

Interface	IF_SRM_SP_DOCUMENT
Short Description	Document API

General Data

Package	SRM_GENERAL_SP	SRM General SPs
Created	20000217	SAP
Last changed	20130531	SAP
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	IF_SRM	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
2	SRMGS	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Interface IF_SRM_SP_DOCUMENT has no interface.

Friends

Interface IF_SRM_SP_DOCUMENT has no friend.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	ACT_CANCEL_CHECKOUT	Constant	Public	☐	Type reference (TYPE)	STRING	'CANCEL_CHECKOUT'		20041124
2	ACT_CHECKIN	Constant	Public	☐	Type reference (TYPE)	STRING	'CHECKIN'		20041124
3	ACT_CHECKOUT	Constant	Public	☐	Type reference (TYPE)	STRING	'CHECKOUT'		20041124
4	ACT_COPY	Constant	Public	☐	Type reference (TYPE)	STRING	'COPY'		20041207
5	ACT_DOWNLOAD	Constant	Public	☐	Type reference (TYPE)	STRING	'DOWNLOAD'		20041124
6	ACT_UPLOAD	Constant	Public	☐	Type reference (TYPE)	STRING	'UPLOAD'		20041124
7	C_ATTR_SECOND_REF_RULE	Constant	Public	☐	Type reference (TYPE)	STRING	'SRM_SECOND_REF_RULE'		20090910
8	C_CM_PARAM_SECOND_REF_RULE	Constant	Public	☐	Type reference (TYPE)	STRING	'SECOND_REF_RULE'		20090910
9	C_CONN_PARAM_TMPL_PROFILE_PDF	Constant	Public	☐	Type reference (TYPE)	STRING	'TEMPLATE_PROFILE_PDF'		20050330
10	C_CONN_PARA_CREATE_VIA_TMPL	Constant	Public	☐	Type reference (TYPE)	STRING	'CREATE_ONLY_VIA_TEMPLATE'		20030828
11	C_CONN_PARA_EXECUTE	Constant	Public	☐	Type reference (TYPE)	STRING	'DOCUMENT_EXECUTE'	Control the execution of the document	20080411
12	C_CONN_PARA_FORM_DATA_FROM_DOC	Constant	Public	☐	Type reference (TYPE)	STRING	'FLAG_FORM_DATA_FROM_DOC'		20050330
13	C_CONN_PARA_FUNC_GET_FORM_DATA	Constant	Public	☐	Type reference (TYPE)	STRING	'FUNCTION_GET_FORM_DATA'		20030902
14	C_CONN_PARA_TEMPLATE_ID	Constant	Public	☐	Type reference (TYPE)	STRING	'TEMPLATE_ID'		20030902
15	C_CONN_PARA_TMPL_PROFILE	Constant	Public	☐	Type reference (TYPE)	STRING	'TEMPLATE_PROFILE'		20030828
16	C_CONN_PARA_TMPL_SPS_ID	Constant	Public	☐	Type reference (TYPE)	STRING	'TEMPLATE_SPS_ID'		20030828
17	C_STAT_NO_CONTENT	Constant	Public	☐	Type reference (TYPE)	STRING	'NO_CONTENT'	Document has only attr., but no content	20090812

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CLEAR_GSP_CACHE	Instance method	Public	Method	Discard GSP Buffering	20050413
2	CLOSE	Instance method	Public	Method	Close Document	20020712
3	CONFIRM_PUT	Instance method	Public	Method	Confirm URL Transfer to Backend	20020712
4	COPY	Instance method	Public	Method		20041207
5	CREATE	Instance method	Public	Method	Create New Document	20020712
6	CREATE_FROM_TEMPLATE	Instance method	Public	Method		20041210
7	DELETE	Instance method	Public	Method	Delete Document	20020712
8	GET_ATTRIBUTES	Instance method	Public	Method	Get Attributes of the Document	20020712
9	GET_CONTENT_FILE_INFO	Instance method	Public	Method	Get Content File Information	20020712
10	GET_CONTENT_VIA_FILE	Instance method	Public	Method	Pass Content to Frontend	20020712
11	GET_CONTENT_VIA_TAB	Instance method	Public	Method	Get Document Content via Table	20020712
12	GET_TEMPLATES	Instance method	Public	Method		20041213
13	GET_URL_FOR_GET	Instance method	Public	Method	Get URLs for Read Access to Document	20020712
14	GET_URL_FOR_PUT	Instance method	Public	Method	Get URLs for Writing Document	20020712
15	GET_VERSION_LIST	Instance method	Public	Method	Get Version List	20020723
16	GET_VERSION_LIST2	Instance method	Public	Method	Get Version List (for Conversion to GSP 2)	20041129
17	OPEN	Instance method	Public	Method	Open Document to Display/Change	20020712
18	REMOVE_CONTENT	Instance method	Public	Method	Delete Document Content	20090812
19	RETRIEVE_VERSION	Instance method	Public	Method	Return this non-current version for the current version	20050427
20	SET_ATTRIBUTES	Instance method	Public	Method	Set Document Attributes	20020712
21	SET_CONTENT_VIA_FILE	Instance method	Public	Method	Pass Content to Backend	20020712
22	SET_CONTENT_VIA_TAB	Instance method	Public	Method	Set Content via Table	20020712
23	UPDATE_STATE_CLOSED	Instance method	Public	Method	SP Acvtivity: Close/Open Document	20030220

Events

Interface IF_SRM_SP_DOCUMENT has no event.

Types

Interface IF_SRM_SP_DOCUMENT has no local type.

Method Signatures

Method CLEAR_GSP_CACHE Signature

Method CLEAR_GSP_CACHE on Interface IF_SRM_SP_DOCUMENT has no parameter.
Method CLEAR_GSP_CACHE on Interface IF_SRM_SP_DOCUMENT has no exception.

Method CLOSE 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)	SRMBOOLEAN	IF_SRM=>TRUE	'X': commit work	20020712

Method CLOSE on Interface IF_SRM_SP_DOCUMENT has no exception.

Method CONFIRM_PUT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	COMPONENT_TAB	Call by reference	☐	Type reference (TYPE)	SRMGS_COMPONENTS		Komponenten Tab	20020712
2	Importing	URL_TAB	Call by reference	☐	Type reference (TYPE)	SRMGS_URL_TAB		URL Tab	20020712

#	Exception	Resumable	Description	Created on
1	CX_SRM_DOCUMENT_CLIENT	☐	Document Client	20020715

Method COPY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DESCRIPTION_COPY	Call by reference	☑	Type reference (TYPE)	STRING			20041207
2	Importing	DOC_ID_COPY	Call by reference	☑	Type reference (TYPE)	STRING			20041207
3	Exporting	EX_POID_COPY	Call by reference	☐	Object reference (TYPE REF TO)	IF_SRM_POID		POID	20050706

#	Exception	Resumable	Description	Created on
1	CX_SRM_DOCUMENT_CLIENT	☐	Document Client	20041207

Method CREATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DESCRIPTION	Value transfer	☑	Type reference (TYPE)	STRING		Kurzbeschreibung	20020712
2	Importing	DO_COMMIT	Value transfer	☐	Type reference (TYPE)	SRMBOOLEAN	IF_SRM=>TRUE	'X': do commit nach Anlegen von Doc	20020715
3	Importing	ID	Value transfer	☑	Type reference (TYPE)	STRING		Eindeutige Bezeichnung	20020712
4	Importing	ID_CHECK_UNIQUE	Value transfer	☐	Type reference (TYPE)	SRMBOOLEAN	IF_SRM=>TRUE	Eindeutigkeit der Bezeichnung für die anzulegende Dok pruef	20110222
5	Importing	PROPERTY_LOIO	Value transfer	☑	Type reference (TYPE)	SRMGS_PROPERTY_TAB			20080623
6	Importing	PROPERTY_PHIO	Value transfer	☑	Type reference (TYPE)	SRMGS_PROPERTY_TAB			20080623
7	Returning	RE_DOC_ID	Value transfer	☐	Type reference (TYPE)	STRING		Dokument ID des neu angelegten Doc	20020716
8	Importing	SUPPRESS_EVENT_FLAG	Value transfer	☐	Type reference (TYPE)	SRMBOOLEAN	IF_SRM=>FALSE		20060512

#	Exception	Resumable	Description	Created on
1	CX_SRM_DOCUMENT_CLIENT	☐	Document Client	20020715

Method CREATE_FROM_TEMPLATE 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)	SRMBOOLEAN		Boolean: Mögliche Werte IF_SRM=>TRUE / FALSE	20041210
2	Returning	RE_DOC_ID	Value transfer	☐	Type reference (TYPE)	STRING		Dokument ID des neu angelegten Doc	20081231
3	Importing	SUPPRESS_EVENT_FLAG	Value transfer	☐	Type reference (TYPE)	SRMBOOLEAN	IF_SRM=>FALSE		20060512
4	Importing	TEMPLATE_DOC_ID	Call by reference	☐	Type reference (TYPE)	CSEQUENCE			20041210
5	Importing	TEMPLATE_SPS_ID	Call by reference	☐	Type reference (TYPE)	CSEQUENCE			20041210

#	Exception	Resumable	Description	Created on
1	CX_SRM_DOCUMENT_CLIENT	☐	Document Client	20041210

Method DELETE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DO_COMMIT	Value transfer	☐	Type reference (TYPE)	SRMBOOLEAN	IF_SRM=>TRUE	'X': do commit	20020715
2	Importing	DO_LOG	Value transfer	☐	Type reference (TYPE)	SRMBOOLEAN	IF_SRM=>TRUE	Boolean: Mögliche Werte IF_SRM=>TRUE / FALSE	20030220
3	Importing	DO_RAISE_WF_EVT	Value transfer	☐	Type reference (TYPE)	SRMBOOLEAN	IF_SRM=>TRUE	Boolean: Mögliche Werte IF_SRM=>TRUE / FALSE	20030220
4	Importing	VERSION	Value transfer	☑	Type reference (TYPE)	STRING		zu löschende phys. Version	20020723
5	Importing	WHOLE_DOCUMENT	Value transfer	☐	Type reference (TYPE)	SRMBOOLEAN	IF_SRM=>TRUE	'X': alle Versionen löschen; space: nur gegebene Version	20020715

#	Exception	Resumable	Description	Created on
1	CX_SRM_DOCUMENT_CLIENT	☐	Document Client	20020715

Method GET_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ATTRIBUTE_TAB	Call by reference	☐	Type reference (TYPE)	SRMGS_PROPERTY_TAB		Attributtabelle	20020712
2	Importing	DO_LOG	Call by reference	☐	Type reference (TYPE)	SRMBOOLEAN	IF_SRM=>TRUE	Boolean: Mögliche Werte IF_SRM=>TRUE / FALSE	20050504
3	Importing	OMIT_CACHE	Value transfer	☐	Type reference (TYPE)	SRMBOOLEAN	IF_SRM=>FALSE	Boolean: Mögliche Werte IF_SRM=>TRUE / FALSE	20040203
4	Importing	REQ_ATTRIBUTE_TAB	Value transfer	☑	Type reference (TYPE)	SRMGS_PROPERTY_TAB		Requested props	20030410
5	Importing	SINGLE_FETCH	Value transfer	☐	Type reference (TYPE)	SRMBOOLEAN	IF_SRM=>FALSE	Boolean: Mögliche Werte IF_SRM=>TRUE / FALSE	20040203
6	Importing	WHOLE_DOCUMENT	Value transfer	☐	Type reference (TYPE)	SRMBOOLEAN	IF_SRM=>FALSE	X': setze props am Dokument; space: setze props an Variante	20020715

#	Exception	Resumable	Description	Created on
1	CX_SRM_DOCUMENT_CLIENT	☐	Document Client	20020715

Method GET_CONTENT_FILE_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	FILE_INFO_TAB	Call by reference	☐	Type reference (TYPE)	SRMGS_COMPONENTS		file info tab	20020712

#	Exception	Resumable	Description	Created on
1	CX_SRM_DOCUMENT_CLIENT	☐	Document Client	20020715

Method GET_CONTENT_VIA_FILE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	FILE_TAB	Call by reference	☐	Type reference (TYPE)	SRMGS_FILE_TAB		File Tab	20020712
2	Importing	IM_SET_CHECKED_OUT	Value transfer	☐	Type reference (TYPE)	SRMBOOLEAN	IF_SRM=>FALSE	'X': setze Status ausgecheckt	20030409

#	Exception	Resumable	Description	Created on
1	CX_SRM_DOCUMENT_CLIENT	☐	Document Client	20020715

Method GET_CONTENT_VIA_TAB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ASCII_CONTENT	Call by reference	☐	Type reference (TYPE)	SRMGS_ASCII_CONTENT		Tabelle von Ascii Content	20020712
2	Exporting	BIN_CONTENT	Call by reference	☐	Type reference (TYPE)	SRMGS_BIN_CONTENT		Tabelle von binärem Content	20020712
3	Exporting	COMPONENT_TAB	Call by reference	☐	Type reference (TYPE)	SRMGS_COMPONENTS		Tabelle von Informationen überr Komponenten	20020712
4	Importing	IM_SET_CHECKED_OUT	Value transfer	☐	Type reference (TYPE)	SRMBOOLEAN	IF_SRM=>FALSE	'X': Setze Status ausgecheckt	20030409

#	Exception	Resumable	Description	Created on
1	CX_SRM_DOCUMENT_CLIENT	☐	Document Client	20020715

Method GET_TEMPLATES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	TEMPLATE_TAB	Call by reference	☐	Type reference (TYPE)	SRMDOCTEMPLATETAB		Tabelle von Dokumentvorlagen	20041213

#	Exception	Resumable	Description	Created on
1	CX_SRM_DOCUMENT_CLIENT	☐	Document Client	20041213

Method GET_URL_FOR_GET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	COMPONENT_TAB	Call by reference	☐	Type reference (TYPE)	SRMGS_COMPONENTS		Tab. Komponenten Info	20020712
2	Importing	IM_SET_CHECKED_OUT	Value transfer	☐	Type reference (TYPE)	SRMBOOLEAN	IF_SRM=>FALSE	'X': setze Status ausgecheckt	20030409
3	Importing	IM_WEB_URL_ONLY	Call by reference	☐	Type reference (TYPE)	SRMBOOLEAN	IF_SRM=>FALSE	'X': nur Web URL	20041112
4	Exporting	URL_TAB	Call by reference	☐	Type reference (TYPE)	SRMGS_URL_TAB		URL Tabelle	20020712

#	Exception	Resumable	Description	Created on
1	CX_SRM_DOCUMENT_CLIENT	☐	Document Client	20020715

Method GET_URL_FOR_PUT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	AS_NEW_VERSION	Value transfer	☑	Type reference (TYPE)	SRMBOOLEAN		'X': as neue Version	20020712
2	Importing	COMPONENT_TAB	Call by reference	☐	Type reference (TYPE)	SRMGS_COMPONENTS		Komponenten Tab	20020712
3	Importing	GET_HTTP_URL	Call by reference	☑	Type reference (TYPE)	SRMBOOLEAN		'X': http url	20121026
4	Exporting	URL_TAB	Call by reference	☐	Type reference (TYPE)	SRMGS_URL_TAB		URL Tab	20020712

#	Exception	Resumable	Description	Created on
1	CX_SRM_DOCUMENT_CLIENT	☐	Document Client	20020715

Method GET_VERSION_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	VERSION_TAB	Call by reference	☐	Type reference (TYPE)	BAPIDOCVERSTAB		SRM BAPI: Tabelle von Version-Inforamtionen	20020723

#	Exception	Resumable	Description	Created on
1	CX_SRM_DOCUMENT_CLIENT	☐	Document Client	20020723

Method GET_VERSION_LIST2 Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	VERSION_TAB	Value transfer	☐	Type reference (TYPE)	BAPIDOCVERSTAB2		SRM BAPI: Tabelle von Version-Inforamtionen GSP 2	20041129

#	Exception	Resumable	Description	Created on
1	CX_SRM_DOCUMENT_CLIENT	☐	Document Client	20041214

Method OPEN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	COMMIT_MODE	Value transfer	☐	Type reference (TYPE)	SRMBOOLEAN	IF_SRM=>FALSE	'X': auto commit nach Attr./Content Modifikation	20020715
2	Importing	FOR_UPDATE	Value transfer	☐	Type reference (TYPE)	SRMBOOLEAN	IF_SRM=>FALSE	'X': doc zum Update öffnen	20020712

#	Exception	Resumable	Description	Created on
1	CX_SRM_DOCUMENT_CLIENT	☐	Document Client	20020715

Method REMOVE_CONTENT Signature

Method REMOVE_CONTENT on Interface IF_SRM_SP_DOCUMENT has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_SRM_DOCUMENT_CLIENT	☐	Document Client	20090812

Method RETRIEVE_VERSION 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)	SRMBOOLEAN	IF_SRM=>TRUE	Boolean: Mögliche Werte IF_SRM=>TRUE / FALSE	20050427
2	Importing	DO_LOG	Call by reference	☐	Type reference (TYPE)	SRMBOOLEAN	IF_SRM=>TRUE	Boolean: Mögliche Werte IF_SRM=>TRUE / FALSE	20050427
3	Exporting	EX_ACTUAL_VERSION	Call by reference	☐	Object reference (TYPE REF TO)	IF_SRM_SP_DOCUMENT		Document API	20050427
4	Exporting	EX_POID_ACTUAL_VERSION	Call by reference	☐	Object reference (TYPE REF TO)	IF_SRM_POID		POID	20050427

#	Exception	Resumable	Description	Created on
1	CX_SRM_DOCUMENT_CLIENT	☐	Document Client	20050427

Method SET_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ATTRIBUTE_TAB	Call by reference	☑	Type reference (TYPE)	SRMGS_PROPERTY_TAB		Attributliste	20020712
2	Importing	DELETE_ATTRIBUTE_TAB	Call by reference	☑	Type reference (TYPE)	SRMGS_PROPERTY_TAB		Attr., welche gelöscht werden sollen	20020715
3	Importing	WHOLE_DOCUMENT	Value transfer	☐	Type reference (TYPE)	SRMBOOLEAN	IF_SRM=>FALSE	'X': setze props am Dokument; space: setze props an Variante	20020715

#	Exception	Resumable	Description	Created on
1	CX_SRM_DOCUMENT_CLIENT	☐	Fehler vom Backend des Document Client	20020715

Method SET_CONTENT_VIA_FILE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	AS_NEW_VERSION	Value transfer	☑	Type reference (TYPE)	SRMBOOLEAN		'X': as neue Version	20020712
2	Importing	FILE_TAB	Call by reference	☐	Type reference (TYPE)	SRMGS_FILE_TAB		File tab	20020712
3	Importing	VSCAN_PROFILE	Value transfer	☐	Type reference (TYPE)	VSCAN_PROFILE	'/SRM/RCM_CREATE'	Viren-Scan-Profil	20120112

#	Exception	Resumable	Description	Created on
1	CX_SRM_DOCUMENT_CLIENT	☐	Document Client	20020715

Method SET_CONTENT_VIA_TAB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ASCII_CONTENT	Call by reference	☑	Type reference (TYPE)	SRMGS_ASCII_CONTENT		ASCII Content	20020715
2	Importing	AS_NEW_VERSION	Value transfer	☐	Type reference (TYPE)	SRMBOOLEAN	IF_SRM=>FALSE	'X': Dokument as neue Version einchecken	20020712
3	Importing	BIN_CONTENT	Call by reference	☑	Type reference (TYPE)	SRMGS_BIN_CONTENT		Binär Content	20020715
4	Importing	COMPONENT_TAB	Call by reference	☐	Type reference (TYPE)	SRMGS_COMPONENTS		Component info	20020715
5	Importing	SUPPRESS_EVENT_FLAG	Value transfer	☐	Type reference (TYPE)	SRMBOOLEAN	IF_SRM=>FALSE		20060512
6	Importing	VSCAN_PROFILE	Value transfer	☐	Type reference (TYPE)	VSCAN_PROFILE	'/SRM/RCM_CREATE'	Viren-Scan-Profil	20120113

#	Exception	Resumable	Description	Created on
1	CX_SRM_DOCUMENT_CLIENT	☐	Document Client	20020715

Method UPDATE_STATE_CLOSED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_DO_CLOSE	Value transfer	☐	Type reference (TYPE)	SRMBOOLEAN	IF_SRM=>TRUE	'X': Doc. abschließen; space: aufschließen	20030220

#	Exception	Resumable	Description	Created on
1	CX_SRM_DOCUMENT_CLIENT	☐	Document Client	20030220

History

Last changed by/on	SAP	20130531
SAP Release Created in	620