SAP ABAP Interface IF_SRM_SP_BDV_WIN (BDV: Special Methods for Win)

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_BDV	BDV: Basis Class	20000529

Properties

Interface	IF_SRM_SP_BDV_WIN
Short Description	BDV: Special Methods for Win

General Data

Package	SRM_GENERAL_SP	SRM General SPs
Created	20000529	SAP
Last changed	20110908	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)
3	SRMGU	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
4	SRMIF	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Interface IF_SRM_SP_BDV_WIN has no interface.

Friends

Interface IF_SRM_SP_BDV_WIN has no friend.

Attributes

Interface IF_SRM_SP_BDV_WIN has no attribute.

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CANCEL_EDIT_DOI_DOC	Instance method	Public	Method	Cancel editting DOI document	20010309
2	CANCEL_EDIT_TEXT_DOC	Instance method	Public	Method	Cancel editting in text editor	20020212
3	CHECK_ACTIVITY_INPLACE	Instance method	Public	Method	Checks whether current MIME type can be edited inplace	20010607
4	CREATE_DOC_FROM_TEMPLATE	Instance method	Public	Method	Create new DOI document from template	20020409
5	CREATE_NEW_DOC_VIA_DOI	Instance method	Public	Method	Create new document using DOI	20000704
6	CREATE_NEW_DOC_VIA_FILE	Instance method	Public	Method	Create new document using Fileselection	20000704
7	CREATE_NEW_DOC_VIA_TEXTEDIT	Instance method	Public	Method	Create new document via text editor	20020207
8	DISPLAY_DOI_DOC	Instance method	Public	Method	Display document using DOI	20000529
9	DISPLAY_EAI2D_DOC	Instance method	Public	Method	Display 2D - document using EAI	20000607
10	DISPLAY_EAI3D_DOC	Instance method	Public	Method	Display 3D - document using EAI	20000607
11	DISPLAY_EMPTY_DOC	Instance method	Public	Method		20090812
12	DISPLAY_HTML_DOC	Instance method	Public	Method	Display document using HTML	20000529
13	DISPLAY_TEXT_DOC	Instance method	Public	Method	display document via text editor	20020213
14	DISPLAY_UNSUPPORTED_DOC	Instance method	Public	Method	Displays an unsupported document type (static HTML message)	20010607
15	DOWNLOAD_DOC	Instance method	Public	Method	Download Document	20010612
16	MODIFY_DOI_DOC	Instance method	Public	Method	Modify DOI document	20000807
17	MODIFY_TEXT_DOC	Instance method	Public	Method	Modify txt document	20020213
18	SAVE_MODIFIED_DOI_DOC	Instance method	Public	Method	Save modified DOI document	20000908
19	SAVE_NEW_DOI_DOC	Instance method	Public	Method	Save new DOI document	20000717
20	SAVE_TEXT_DOC	Instance method	Public	Method	Save new text document	20020213
21	START_NEW_DOI_APP	Instance method	Public	Method	Start DOI application	20000725
22	UPLOAD_DOC	Instance method	Public	Method	Upload Document (as new version)	20010612

Events

Interface IF_SRM_SP_BDV_WIN has no event.

Types

Interface IF_SRM_SP_BDV_WIN has no local type.

Method Signatures

Method CANCEL_EDIT_DOI_DOC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_SP_POID_TAB	Call by reference	☐	Type reference (TYPE)	SRM_LIST_POID		SP POID	20010309
2	Importing	IM_ATTRIBUTE_VALUE_LIST	Call by reference	☑	Type reference (TYPE)	SRM_LIST_OBJECT		Corresponding object	20010309

#	Exception	Resumable	Description	Created on
1	BDV_CANCELED	☐	BDV: User has canceled the action	20010309
2	BDV_NOT_AUTHORIZED	☐	BDV: User is not authorized	20010309
3	BDV_UNEXPECTED_ERROR	☐	BDV: Unexpected error	20010309

Method CANCEL_EDIT_TEXT_DOC Signature

Method CANCEL_EDIT_TEXT_DOC on Interface IF_SRM_SP_BDV_WIN has no parameter.

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

Method CHECK_ACTIVITY_INPLACE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ACTIVITY	Value transfer	☐	Type reference (TYPE)	SRMIF_SP_ACTIVITY		Aktivität	20010607
2	Returning	INPLACE_SUPPORTED	Value transfer	☐	Type reference (TYPE)	SRMBOOLEAN		wird unterstützt	20010607
3	Importing	POID	Value transfer	☐	Object reference (TYPE REF TO)	OBJECT		POID Referenz	20010607

#	Exception	Resumable	Description	Created on
1	BDV_NOT_AUTHORIZED	☐	fehlende Berechtigung	20010607
2	BDV_NO_MIMETYPE	☐	der Mimetyp konnte nicht bestimmt werden	20010607
3	BDV_UNEXPECTED_ERROR	☐	interner Fehler	20010607

Method CREATE_DOC_FROM_TEMPLATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_DOC_ID	Value transfer	☑	Type reference (TYPE)	SRMGS_DOC_ID		OBSOLETE: Template Doc ID	20020409
2	Importing	IM_TEMPLATE	Call by reference	☐	Type reference (TYPE)	SRMGU_DOC_TEMPLATE			20030901

#	Exception	Resumable	Description	Created on
1	CX_SRM_DCL_BACKEND	☐	Fehler vom Backend des Document Client	20020409
2	CX_SRM_DOCUMENT_CLIENT	☐	Document Client	20020708

Method CREATE_NEW_DOC_VIA_DOI Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_SP_POID_TAB	Call by reference	☐	Type reference (TYPE)	SRM_LIST_POID		SP POID	20000704
2	Exporting	EX_USER_ACTION	Call by reference	☐	Type reference (TYPE)	C		User action	20000815

#	Exception	Resumable	Description	Created on
1	SRM_UNEXPECTED_ERROR	☐	SRM: Unexpected Error	20000704

Method CREATE_NEW_DOC_VIA_FILE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_SP_POID_TAB	Call by reference	☐	Type reference (TYPE)	SRM_LIST_POID		SP POID	20000704
2	Exporting	EX_USER_ACTION	Call by reference	☐	Type reference (TYPE)	C		User action	20000815
3	Importing	IM_FILE	Call by reference	☑	Type reference (TYPE)	CHAR255		Full path of local file	20020211

#	Exception	Resumable	Description	Created on
1	BDV_NOT_AUTHORIZED	☐	BDV: User is not authorized	20010301
2	BDV_UNEXPECTED_ERROR	☐	BDV: Unexpected Error	20000717

Method CREATE_NEW_DOC_VIA_TEXTEDIT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_SP_POID_TAB	Call by reference	☐	Type reference (TYPE)	SRM_LIST_POID		SP POID	20020207
2	Importing	IM_ATTRIBUTE_VALUE_LIST	Call by reference	☑	Type reference (TYPE)	SRM_LIST_OBJECT		Corresponding object	20020207

Method CREATE_NEW_DOC_VIA_TEXTEDIT on Interface IF_SRM_SP_BDV_WIN has no exception.

Method DISPLAY_DOI_DOC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_ATTRIBUTE_VALUE_LIST	Call by reference	☑	Type reference (TYPE)	SRM_LIST_OBJECT		Corresponding Object	20000530
2	Importing	IM_COMP_ID	Call by reference	☑	Type reference (TYPE)	STRING		Komponent ID	20021024
3	Importing	IM_FILE_TAB	Call by reference	☑	Type reference (TYPE)	SRMGS_FILE_TAB		Correponding document	20000706
4	Importing	IM_MIMETYPE	Call by reference	☑	Type reference (TYPE)	SRMIF_SP_MIMETYPE		Mimetype of the Object	20000607
5	Importing	IM_OLE_NAME	Call by reference	☑	Type reference (TYPE)	STRING		Ole name of the application to start	20000608

#	Exception	Resumable	Description	Created on
1	BDV_NOT_AUTHORIZED	☐	User is not authorized	20010301
2	BDV_UNEXPECTED_ERROR	☐	Unexpected Error	20000607

Method DISPLAY_EAI2D_DOC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_ATTRIBUTE_VALUE_LIST	Call by reference	☑	Type reference (TYPE)	SRM_LIST_OBJECT		Corresponding object	20000607
2	Importing	IM_COMP_ID	Call by reference	☑	Type reference (TYPE)	STRING		Komponet ID	20021024
3	Importing	IM_FILE_TAB	Call by reference	☑	Type reference (TYPE)	SRMGS_FILE_TAB		Corresponding Document	20000706
4	Importing	IM_MIMETYPE	Call by reference	☑	Type reference (TYPE)	SRMIF_SP_MIMETYPE		Mimetype of the Object	20000607

#	Exception	Resumable	Description	Created on
1	BDV_NOT_AUTHORIZED	☐	User is not authorized	20010301
2	BDV_UNEXPECTED_ERROR	☐	Unexpected Error	20000607

Method DISPLAY_EAI3D_DOC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_ATTRIBUTE_VALUE_LIST	Call by reference	☑	Type reference (TYPE)	SRM_LIST_OBJECT		Corresponding object	20000607
2	Importing	IM_COMP_ID	Call by reference	☑	Type reference (TYPE)	STRING		Komponet ID	20021024
3	Importing	IM_FILE_TAB	Call by reference	☑	Type reference (TYPE)	SRMGS_FILE_TAB		Correspondung Document	20000706
4	Importing	IM_MIMETYPE	Call by reference	☑	Type reference (TYPE)	SRMIF_SP_MIMETYPE		Mimetype of the Object	20000607

#	Exception	Resumable	Description	Created on
1	BDV_NOT_AUTHORIZED	☐	User is not authorized	20010301
2	BDV_UNEXPECTED_ERROR	☐	Unexpected Error	20000607

Method DISPLAY_EMPTY_DOC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_ATTRIBUTE_VALUE_LIST	Call by reference	☑	Type reference (TYPE)	SRM_LIST_OBJECT		List: Object	20090812
2	Importing	IM_FILE_TAB	Call by reference	☑	Type reference (TYPE)	SRMGS_FILE_TAB			20090812
3	Importing	IM_MIMETYPE	Call by reference	☑	Type reference (TYPE)	SRMIF_SP_MIMETYPE			20090812

#	Exception	Resumable	Description	Created on
1	BDV_NOT_AUTHORIZED	☐		20090812
2	BDV_OWN_APPLICATION	☐		20090812
3	BDV_UNEXPECTED_ERROR	☐		20090812

Method DISPLAY_HTML_DOC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_ATTRIBUTE_VALUE_LIST	Call by reference	☑	Type reference (TYPE)	SRM_LIST_OBJECT		Corresponding Object	20000530
2	Importing	IM_COMP_ID	Call by reference	☑	Type reference (TYPE)	STRING		Komponet ID	20021024
3	Importing	IM_FILE_TAB	Call by reference	☑	Type reference (TYPE)	SRMGS_FILE_TAB		Correponding Document	20000706
4	Importing	IM_MIMETYPE	Call by reference	☑	Type reference (TYPE)	SRMIF_SP_MIMETYPE		Mimetype of the Object	20000607

#	Exception	Resumable	Description	Created on
1	BDV_NOT_AUTHORIZED	☐	BDV: User is not authorized	20010301
2	BDV_UNEXPECTED_ERROR	☐	BDV: Unexpected Error	20000529

Method DISPLAY_TEXT_DOC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_COMP_ID	Call by reference	☑	Type reference (TYPE)	STRING		Komponet ID	20021024

#	Exception	Resumable	Description	Created on
1	CX_SRM_DCL_BACKEND	☐	Fehler vom Backend des Document Client	20020213
2	CX_SRM_DOCUMENT_CLIENT	☐	Document Client	20020213

Method DISPLAY_UNSUPPORTED_DOC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_ATTRIBUTE_VALUE_LIST	Call by reference	☑	Type reference (TYPE)	SRM_LIST_OBJECT		Corresponding Object	20010607
2	Importing	IM_FILE_TAB	Call by reference	☑	Type reference (TYPE)	SRMGS_FILE_TAB		Correponding Document	20010607
3	Importing	IM_MIMETYPE	Call by reference	☑	Type reference (TYPE)	SRMIF_SP_MIMETYPE		Mimetype of the Object	20010607

#	Exception	Resumable	Description	Created on
1	BDV_NOT_AUTHORIZED	☐	BDV: User is not authorized	20010607
2	BDV_OWN_APPLICATION	☐	BDV: Display is done with own application	20010607
3	BDV_UNEXPECTED_ERROR	☐	BDV: Unexpected Error	20010607

Method DOWNLOAD_DOC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_DOWNLOAD_PATH	Call by reference	☐	Type reference (TYPE)	SRMGU_STR_TAB		Absoluter Download-Path	20030127
2	Importing	IM_ATTRIBUTE_VALUE_LIST	Call by reference	☐	Type reference (TYPE)	SRM_LIST_OBJECT		Attribute	20010612

#	Exception	Resumable	Description	Created on
1	CX_SRM_DOCUMENT_CLIENT	☐	Document Client	20011002
2	CX_SRM_FRAMEWORK	☐	Framework (abstrakt)	20011002
3	CX_SRM_NO_AUTHORIZATION	☐	Fehlende Berechtigung	20011002
4	CX_SRM_SPCL_USER_CANCEL	☐	SP Client : Abbruch durch Benutzer	20011002

Method MODIFY_DOI_DOC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_ATTRIBUTE_VALUE_LIST	Call by reference	☑	Type reference (TYPE)	SRM_LIST_OBJECT		Corresponding Object	20000807
2	Importing	IM_FILE_TAB	Call by reference	☑	Type reference (TYPE)	SRMGS_FILE_TAB		Correponding document	20000807
3	Importing	IM_MIMETYPE	Call by reference	☑	Type reference (TYPE)	SRMIF_SP_MIMETYPE		Mimetype of the object	20000807
4	Importing	IM_OLE_NAME	Call by reference	☑	Type reference (TYPE)	STRING		Ole name of the application	20000807

#	Exception	Resumable	Description	Created on
1	BDV_LOCKED	☐	BDV: Document is locked	20011031
2	BDV_NOT_AUTHORIZED	☐	BDV: User is not authorized	20010301
3	BDV_UNEXPECTED_ERROR	☐	BDV: Unexpected Error	20000807

Method MODIFY_TEXT_DOC Signature

Method MODIFY_TEXT_DOC on Interface IF_SRM_SP_BDV_WIN has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_SRM_DCL_BACKEND	☐	Fehler vom Backend des Document Client	20020213
2	CX_SRM_DOCUMENT_CLIENT	☐	Document Client	20020213

Method SAVE_MODIFIED_DOI_DOC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_SP_POID_TAB	Call by reference	☐	Type reference (TYPE)	SRM_LIST_POID		SP POID	20000908
2	Importing	IM_ATTRIBUTE_VALUE_LIST	Call by reference	☑	Type reference (TYPE)	SRM_LIST_OBJECT		Corresponding object	20000908
3	Importing	IM_HIDE	Call by reference	☐	Type reference (TYPE)	SRMBOOLEAN	IF_SRM=>FALSE	Boolean: Mögliche Werte IF_SRM=>TRUE / FALSE	20041230
4	Importing	IM_SAVE_AS_NEW_VERSION	Call by reference	☑	Type reference (TYPE)	SRMGS_BOOLEAN		True: document shall be saved as new version	20011211
5	Importing	IM_SWITCH_TO_DISPLAY	Call by reference	☐	Type reference (TYPE)	SRMBOOLEAN	IF_SRM=>TRUE	True: switch to display mode after doc is saved	20020307

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

Method SAVE_NEW_DOI_DOC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_SP_POID_TAB	Call by reference	☐	Type reference (TYPE)	SRM_LIST_POID		SP POID	20000717
2	Importing	IM_ATTRIBUTE_VALUE_LIST	Call by reference	☑	Type reference (TYPE)	SRM_LIST_OBJECT		Corresponding object	20000717

#	Exception	Resumable	Description	Created on
1	CX_SRM_DOCUMENT_CLIENT	☐	Document Client	20020513
2	CX_SRM_SPCL_USER_CANCEL	☐	SP Client : Abbruch durch Benutzer	20020513

Method SAVE_TEXT_DOC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_HIDE	Call by reference	☐	Type reference (TYPE)	SRMBOOLEAN	IF_SRM=>FALSE	Boolean: Mögliche Werte IF_SRM=>TRUE / FALSE	20041230
2	Importing	IM_SAVE_AS_NEW_VERSION	Call by reference	☑	Type reference (TYPE)	SRMBOOLEAN		True: document shall be saved as new logical version	20020213
3	Importing	IM_SWITCH_TO_DISPLAY	Call by reference	☐	Type reference (TYPE)	SRMBOOLEAN	IF_SRM=>TRUE	True: switch to display mode after doc is saved	20020307

#	Exception	Resumable	Description	Created on
1	CX_SRM_DOCUMENT_CLIENT	☐	Document Client	20020213
2	CX_SRM_SPCL_USER_CANCEL	☐	SP Client : Abbruch durch Benutzer	20020213

Method START_NEW_DOI_APP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_OLE_NAME	Call by reference	☐	Type reference (TYPE)	STRING		OLE name of the application	20000725

#	Exception	Resumable	Description	Created on
1	BDV_DOI_ERROR	☐	BDV: Error from the DOI	20000725
2	BDV_UNEXPECTED_ERROR	☐	BDV: Unexpected error	20000725

Method UPLOAD_DOC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_SP_POID_TAB	Call by reference	☐	Type reference (TYPE)	SRM_LIST_POID		SP Poid der neu angelegten Version	20010612
2	Importing	IM_DISPLAY_DOC	Value transfer	☐	Type reference (TYPE)	SRMBOOLEAN	IF_SRM=>TRUE	'X': zeigt nach Upload das Dokument an	20021112
3	Importing	IM_POPUP_AS_NEW_VERSION	Value transfer	☐	Type reference (TYPE)	SRMBOOLEAN	IF_SRM=>TRUE	ob Abfrage "Als neue Version?" angezeigt wird	20020923

#	Exception	Resumable	Description	Created on
1	CX_SRM_DOCUMENT_CLIENT	☐	Document Client	20011002
2	CX_SRM_FRAMEWORK	☐	Framework (abstrakt)	20011002
3	CX_SRM_NO_AUTHORIZATION	☐	Fehlende Berechtigung	20011002
4	CX_SRM_SPCL_USER_CANCEL	☐	SP Client : Abbruch durch Benutzer	20011002

History

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