SAP ABAP Interface IF_DS_SIGN (Digital Signature: Create Signature)

Hierarchy

☛ SAP_ABA (Software Component) Cross-Application Component
   ⤷ CA-DSG (Application Component) Digital Signature
     ⤷ DS (Package) Digital Signature

Properties

Interface	IF_DS_SIGN
Short Description	Digital Signature: Create Signature

General Data

Package	DS	Digital Signature
Created	20010828	SAP
Last changed	20080612	SAP
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	ABAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Interface IF_DS_SIGN has no interface.

Friends

Interface IF_DS_SIGN has no friend.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CO_CANC_PROC	Constant	Public	☐	Type reference (TYPE)	SIGN_ACTION	'P'	Digital Signature: Status of Signature Verification	20011206
2	CO_DOC_TYPE_HTM	Constant	Public	☐	Type reference (TYPE)	SSFTYPE	'HTM'	Document type: HTML	20011206
3	CO_DOC_TYPE_PDF	Constant	Public	☐	Type reference (TYPE)	SSFTYPE	'PDF'	Document type: PDF	20011206
4	CO_DOC_TYPE_TXT	Constant	Public	☐	Type reference (TYPE)	SSFTYPE	'TXT'	Document type: Text	20011206
5	CO_DOC_TYPE_XML	Constant	Public	☐	Type reference (TYPE)	SSFTYPE	'XML'	Document type: XML	20011206
6	CO_SIGNED	Constant	Public	☐	Type reference (TYPE)	SIGN_ACTION	'S'	Digital Signature: Status of Signature Verification	20011206
7	CO_STATE_PROC_CANC	Constant	Public	☐	Type reference (TYPE)	SIGN_STATE	'2'	The Signature Process was Cancelled	20020118
8	CO_STATE_PROC_CLOSED	Constant	Public	☐	Type reference (TYPE)	SIGN_STATE	'1'	Signature Process Closed	20020118
9	CO_STATE_PROC_NEW	Constant	Public	☐	Type reference (TYPE)	SIGN_STATE	' '	New Signature Process was Opened	20020118
10	CO_STATE_PROC_OPEN	Constant	Public	☐	Type reference (TYPE)	SIGN_STATE	'3'	Current Signature Process is not yet Closed	20020118

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_META_OF_INSTANCE	Instance method	Public	Method	Checks Whether Metadata Match Signature Instance	20041026
2	FREE	Instance method	Public	Method	Destructor	20011016
3	GET_ID	Instance method	Public	Method	Read Signature ID	20010925
4	GET_LAST_OPEN_STEP	Instance method	Public	Method	Delivers Last Signature Step (Not Processed Yet)	20080404
5	GET_META_BY_ID	Instance method	Public	Method	Read Meta Data for Signature ID	20011220
6	GET_STATE	Instance method	Public	Method	Determine Signature Status	20011023
7	GET_STEPS	Instance method	Public	Method	Read Data for Individal Step of Signature Strategy	20010906
8	GET_STEPS_WITH_COMMENT	Instance method	Public	Method	Returns Saved Data and Comment for Signature Step	20061025
9	GET_STEPS_WITH_DOC	Instance method	Public	Method	Returns Saved Data/Documents for Signature Step	20050308
10	GET_TIMESTAMP	Instance method	Public	Method	Returns Time Stamp of Signature Instance	20070319
11	REFRESH_SIGNATURE	Instance method	Public	Method	Update Signature Data	20011012
12	SAVE	Instance method	Public	Method	Save Signature Data	20010828
13	SIGN	Instance method	Public	Method	Execute Digital Signature for a Document	20010906
14	SIGN_WD	Instance method	Public	Method	Execute Digital Signature with Web Dynpro (Dialog Box)	20070530
15	SIGN_WD_CHECK_DOCUMENT	Instance method	Public	Method	Digital Signature (inplace): Check Document	20070917
16	SIGN_WD_FINISH	Instance method	Public	Method	Digital Signature: Complete Process	20070913
17	SIGN_WD_INPLACE	Instance method	Public	Method	Execute Digital Signature with Web Dynpro (inplace)	20070913
18	SIGN_WD_SYNC	Instance method	Public	Method	Digital Signature (Synchronous): Interim Step 1	20070910
19	SIGN_WD_SYNC_IS_FINISHED	Instance method	Public	Method	Digital Signature (Synchronous): Interim Step 2	20070910
20	UNDO	Instance method	Public	Method	Reject Signature Data	20010828
21	UNLOCK	Instance method	Public	Method	Unlock Header Data Record for Signature	20060529

Events

Interface IF_DS_SIGN has no event.

Types

Interface IF_DS_SIGN has no local type.

Method Signatures

Method CHECK_META_OF_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	CHECK_RESULT	Value transfer	☐	Type reference (TYPE)	BOOLE_D		X = Metadaten passen zur Signaturinstanz	20041026
2	Importing	IM_META	Call by reference	☐	Type reference (TYPE)	ANY		Metadaten zur Signaturinstanz	20041026
3	Importing	IM_SIGN_APPL	Call by reference	☐	Type reference (TYPE)	SIGN_APPL		Anwendung der Digitalen Signatur	20041026
4	Importing	IM_SIGN_OBJECT	Call by reference	☐	Type reference (TYPE)	SIGN_OBJECT		Objekt zur Digitalen Signatur	20041026

#	Exception	Resumable	Description	Created on
1	CX_DS_EXCEPTION	☐	Basisklasse: Alle Ausnahmen zur Digitale Signatur	20041026
2	CX_DS_MESSAGE	☐	Übergabe von Meldungen in Form von Ausnahmen	20041026
3	CX_DS_METADATA	☐	Metadaten können nicht interpretiert werden	20041026

Method FREE Signature

Method FREE on Interface IF_DS_SIGN has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_DS_EXCEPTION	☐	Digitale Signatur: Basisklasse	20011129

Method GET_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	SIGN_GUID_22		Digitale Signatur: Signaturnummer als GUID der Länge 22	20010925

#	Exception	Resumable	Description	Created on
1	CX_DS_EXCEPTION	☐	Digitale Signatur: Basisklasse	20011129

Method GET_LAST_OPEN_STEP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RS_LAST_OPEN_STEP	Value transfer	☐	Type reference (TYPE)	SIGN_DATA_DB_STRUC		Letzter offener Einzelschritt	20080404

Method GET_LAST_OPEN_STEP on Interface IF_DS_SIGN has no exception.

Method GET_META_BY_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CH_META	Call by reference	☐	Type reference (TYPE)	ANY		Metadaten zur SignaturID	20011220
2	Importing	IM_SIGNID	Call by reference	☐	Type reference (TYPE)	SIGN_GUID_22		Digitale Signatur: Signaturnummer als GUID der Länge 22	20011220

#	Exception	Resumable	Description	Created on
1	CX_DS_EXCEPTION	☐	Basisklasse: Alle Ausnahmen zur Digitale Signatur	20011220

Method GET_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	SIGN_STATE		Digitale Signatur: Status des Signaturverfahrens	20011024

#	Exception	Resumable	Description	Created on
1	CX_DS_EXCEPTION	☐	Digitale Signatur: Basisklasse	20011129

Method GET_STEPS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_VERIFY	Call by reference	☑	Type reference (TYPE)	BOOLE_D		Verifizierung gewünscht	20011009
2	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	SIGN_STEP_TAB		Digitale Signatur: Daten zum Signaturprozess	20011009

#	Exception	Resumable	Description	Created on
1	CX_DS_CONTEXT	☐	Dokument wurde nicht erzeugt	20011205
2	CX_DS_EXCEPTION	☐	Digitale Signatur: Basisklasse	20011129
3	CX_DS_MESSAGE	☐	Übergabe von Meldungen in Form von Ausnahmen	20020201

Method GET_STEPS_WITH_COMMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_SIGN_STEPS	Call by reference	☐	Type reference (TYPE)	SIGN_VERIFY_STEP_TAB		Digitale Signatur: Daten Verifikation	20061025
2	Importing	IV_PROCESS	Call by reference	☐	Type reference (TYPE)	SIGN_PROC		Signaturprozess der Digitalen Signatur	20061025

#	Exception	Resumable	Description	Created on
1	CX_DS_EXCEPTION	☐	Basisklasse: Alle Ausnahmen zur Digitale Signatur	20061025

Method GET_STEPS_WITH_DOC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_DOC_BIN	Call by reference	☐	Type reference (TYPE)	XSTRING		Dokument (Binär-Typ)	20050308
2	Exporting	EX_DOC_TXT	Call by reference	☐	Type reference (TYPE)	STRING		Dokument (Text-File)	20050308
3	Exporting	EX_DOC_TYPE	Call by reference	☐	Type reference (TYPE)	SSFTYPE		SSF-Typbezeichner	20050308
4	Exporting	EX_SIGN_STEP	Call by reference	☐	Type reference (TYPE)	SIGN_VERIFY_STEP_TAB		Digitale Signatur: Daten zum Signaturprozess	20050308
5	Importing	IM_PROCESS	Call by reference	☐	Type reference (TYPE)	SIGN_PROC		Signaturprozess der Digitalen Signatur	20050308
6	Importing	IM_VERIFY	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Datenelement zur Domäne BOOLE: TRUE (='X') und FALSE (=' ')	20050308

#	Exception	Resumable	Description	Created on
1	CX_DS_CONTEXT	☐	Dokument wurde nicht erzeugt	20050308
2	CX_DS_EXCEPTION	☐	Basisklasse: Alle Ausnahmen zur Digitale Signatur	20050308
3	CX_DS_MESSAGE	☐	Übergabe von Meldungen in Form von Ausnahmen	20050308

Method GET_TIMESTAMP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_TIMESTAMP	Value transfer	☐	Type reference (TYPE)	TIMESTAMP		UTC-Zeitstempel in Kurzform (JJJJMMTThhmmss)	20070319

Method GET_TIMESTAMP on Interface IF_DS_SIGN has no exception.

Method REFRESH_SIGNATURE Signature

Method REFRESH_SIGNATURE on Interface IF_DS_SIGN has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_DS_EXCEPTION	☐	Digitale Signatur: Basisklasse	20011129

Method SAVE Signature

Method SAVE on Interface IF_DS_SIGN has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_DS_EXCEPTION	☐	Digitale Signatur: Basisklasse	20011129

Method SIGN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_SEL_REMARK	Call by reference	☐	Type reference (TYPE)	SIGN_REMARK_STRUC		Ausgewählte Bemerkung der Anwendung	20011026
2	Importing	IM_DEFAULT_REMARK_ID	Call by reference	☑	Type reference (TYPE)	SIGN_REMARK_STRUC-ID		Bemerkung (ID), welche als Vorschlag (Listbox) gesetzt wird	20060110
3	Importing	IM_DOCRULE	Call by reference	☐	Type reference (TYPE)	SIGN_DRULE	'0001'	Digitale Signatur: Dokumentregel für Aufbau eines Dokuments	20010926
4	Importing	IM_DOCTYPE	Call by reference	☑	Type reference (TYPE)	SSFTYPE		Dokumenttyp (html, xml, gif, tif,...)	20010924
5	Importing	IM_DOC_BIN	Call by reference	☑	Type reference (TYPE)	XSTRING		Dokument in Binärform	20010924
6	Importing	IM_DOC_TXT	Call by reference	☑	Type reference (TYPE)	STRING		Dokument als textartiger File	20010924
7	Importing	IM_REMARKS	Call by reference	☑	Type reference (TYPE)	SIGN_REMARK_TAB		Satz von Bemerkungen aus der Anwendung zur Digit. Signatur	20011023
8	Importing	IM_SIGNER	Call by reference	☑	Type reference (TYPE)	SIGN_USERID		Name des Signierers, der das Objekt hinzugefügt hat	20010913

#	Exception	Resumable	Description	Created on
1	CX_DS_CONTEXT	☐	Dokument wurde nicht erzeugt	20011205
2	CX_DS_ESCAPE	☐	Einzelnes Abbrechen einer Sigantur	20011129
3	CX_DS_EXCEPTION	☐	Basisklasse: Alle Ausnahmen zur Digitale Signatur	20011129
4	CX_DS_MESSAGE	☐	Übergabe von Meldungen in Form von Ausnahmen	20011129

Method SIGN_WD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_COMPONENT_USAGE_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Name der Component-Verwendung	20070926
2	Importing	IM_DEFAULT_REMARK_ID	Call by reference	☑	Type reference (TYPE)	SIGN_REMARK_STRUC-ID		Bemerkung (ID), welche als Vorschlag gesetzt wird	20070530
3	Importing	IM_DOCRULE	Call by reference	☐	Type reference (TYPE)	SIGN_DRULE	'0001'	Digitale Signatur: Dokumentregel für Aufbau eines Dokuments	20070530
4	Importing	IM_DOCTYPE	Call by reference	☑	Type reference (TYPE)	SSFTYPE		Dokumenttyp (html, xml, gif, tif,...)	20070530
5	Importing	IM_DOC_BIN	Call by reference	☑	Type reference (TYPE)	XSTRING		Dokument in Binärform	20070530
6	Importing	IM_DOC_TXT	Call by reference	☑	Type reference (TYPE)	STRING		Dokument als textartiger File	20070530
7	Importing	IM_REMARKS	Call by reference	☑	Type reference (TYPE)	SIGN_REMARK_TAB		Satz von Bemerkungen aus der Anwendung zur Digit. Signatur	20070530
8	Importing	IM_SIGNER	Call by reference	☑	Type reference (TYPE)	SIGN_USERID		Name des Signierers, der das Objekt hinzugefügt hat	20070530
9	Importing	IM_TITLE	Call by reference	☑	Type reference (TYPE)	STRING		Titel des Dialogfensters	20070926
10	Importing	IO_SIGNATURE_WD	Call by reference	☐	Object reference (TYPE REF TO)	IWCI_SIGNATURE		WebDynpro Interface-Controller	20070604
11	Importing	IO_WINDOW_MANAGER	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_WINDOW_MANAGER		Window Manager	20070910

#	Exception	Resumable	Description	Created on
1	CX_DS_CONTEXT	☐	Dokument wurde nicht erzeugt	20070530
2	CX_DS_EXCEPTION	☐	Basisklasse: Alle Ausnahmen zur Digitale Signatur	20070530
3	CX_DS_MESSAGE	☐	Übergabe von Meldungen in Form von Ausnahmen	20070530

Method SIGN_WD_CHECK_DOCUMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_DOCRULE	Call by reference	☐	Type reference (TYPE)	SIGN_DRULE	'0001'	Digitale Signatur: Dokumentregel für Aufbau eines Dokuments	20070917
2	Importing	IM_DOCTYPE	Call by reference	☑	Type reference (TYPE)	SSFTYPE		Dokumenttyp (html, xml, gif, tif,...)	20070917
3	Importing	IM_DOC_BIN	Call by reference	☑	Type reference (TYPE)	XSTRING		Dokument in Binärform	20070917
4	Importing	IM_DOC_TXT	Call by reference	☑	Type reference (TYPE)	STRING		Dokument als textartiger File	20070917

#	Exception	Resumable	Description	Created on
1	CX_DS_CONTEXT	☐	Dokument wurde nicht erzeugt	20070917
2	CX_DS_EXCEPTION	☐	Basisklasse: Alle Ausnahmen zur Digitale Signatur	20070917
3	CX_DS_MESSAGE	☐	Übergabe von Meldungen in Form von Ausnahmen	20070917

Method SIGN_WD_FINISH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_SEL_REMARK	Call by reference	☐	Type reference (TYPE)	SIGN_REMARK_STRUC		Ausgewählte Bemerkung der Anwendung	20070913

#	Exception	Resumable	Description	Created on
1	CX_DS_ESCAPE	☐	Einzelnes Abbrechen einer Sigantur	20070913
2	CX_DS_EXCEPTION	☐	Basisklasse: Alle Ausnahmen zur Digitale Signatur	20070913
3	CX_DS_MESSAGE	☐	Übergabe von Meldungen in Form von Ausnahmen	20070913

Method SIGN_WD_INPLACE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_DEFAULT_REMARK_ID	Call by reference	☑	Type reference (TYPE)	SIGN_REMARK_STRUC-ID		Bemerkung (ID), welche als Vorschlag gesetzt wird	20070926
2	Importing	IM_DOCRULE	Call by reference	☐	Type reference (TYPE)	SIGN_DRULE	'0001'	Digitale Signatur: Dokumentregel für Aufbau eines Dokuments	20070926
3	Importing	IM_DOCTYPE	Call by reference	☑	Type reference (TYPE)	SSFTYPE		Dokumenttyp (html, xml, gif, tif,...)	20070926
4	Importing	IM_REMARKS	Call by reference	☑	Type reference (TYPE)	SIGN_REMARK_TAB		Satz von Bemerkungen aus der Anwendung zur Digit. Signatur	20070926
5	Importing	IM_SIGNER	Call by reference	☑	Type reference (TYPE)	SIGN_USERID		Name des Signierers, der das Objekt hinzugefügt hat	20070926
6	Importing	IO_SIGNATURE_WD	Call by reference	☐	Object reference (TYPE REF TO)	IWCI_SIGNATURE		WebDynpro Interface-Controller	20070913

#	Exception	Resumable	Description	Created on
1	CX_DS_EXCEPTION	☐	Basisklasse: Alle Ausnahmen zur Digitale Signatur	20070913
2	CX_DS_MESSAGE	☐	Übergabe von Meldungen in Form von Ausnahmen	20070913

Method SIGN_WD_SYNC Signature

Method SIGN_WD_SYNC on Interface IF_DS_SIGN has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_DS_EXCEPTION	☐	Basisklasse: Alle Ausnahmen zur Digitale Signatur	20070910
2	CX_DS_MESSAGE	☐	Basisklasse: Alle Ausnahmen zur Digitale Signatur	20070910

Method SIGN_WD_SYNC_IS_FINISHED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_SYNC_IS_FINISHED	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		'X' = alle Einzelsignaturen sind fertig	20070910

#	Exception	Resumable	Description	Created on
1	CX_DS_EXCEPTION	☐	Basisklasse: Alle Ausnahmen zur Digitale Signatur	20070910
2	CX_DS_MESSAGE	☐	Übergabe von Meldungen in Form von Ausnahmen	20070910

Method UNDO Signature

Method UNDO on Interface IF_DS_SIGN has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_DS_EXCEPTION	☐	Digitale Signatur: Basisklasse	20011129

Method UNLOCK Signature

Method UNLOCK on Interface IF_DS_SIGN has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_DS_EXCEPTION	☐	Basisklasse: Alle Ausnahmen zur Digitale Signatur	20060529

History

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