SAP ABAP Interface IF_DS_SCREEN_HANDLER (Digital Signature: Screen Handler (For Internal Use Only!))

Hierarchy

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

Properties

Interface	IF_DS_SCREEN_HANDLER
Short Description	Digital Signature: Screen Handler (For Internal Use Only!)

General Data

Package	DS	Digital Signature
Created	20010828	SAP
Last changed	20130531	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_SCREEN_HANDLER has no interface.

Friends

Interface IF_DS_SCREEN_HANDLER has no friend.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CO_CANC	Constant	Public	☐	Type reference (TYPE)	SIGN_ACTION	'A'	Cancel	20010907
2	CO_CANC_PROC	Constant	Public	☐	Type reference (TYPE)	SIGN_ACTION	'P'	Process Cancelled	20010925
3	CO_DATA_ERROR	Constant	Public	☐	Type reference (TYPE)	SIGN_VSTATE	'5'	No Entry Data	20011024
4	CO_DOC_ERROR	Constant	Public	☐	Type reference (TYPE)	SIGN_VSTATE	'7'	Incorrect Document	20011122
5	CO_NO_REASON_DISP	Constant	Public	☐	Type reference (TYPE)	FLAG	SPACE	Reason for Signature not Displayed	20011127
6	CO_OPTIONAL	Constant	Public	☐	Type reference (TYPE)	FLAG	SPACE	Optional	20010906
7	CO_PROFILE_ERROR	Constant	Public	☐	Type reference (TYPE)	SIGN_VSTATE	'3'	Error when Accessing the Private Address Book	20011024
8	CO_REQUIRED	Constant	Public	☐	Type reference (TYPE)	FLAG	'X'	Mandatory	20010906
9	CO_SECTK_ERROR	Constant	Public	☐	Type reference (TYPE)	SIGN_VSTATE	'2'	Error in Security Product	20011024
10	CO_SIGNATURE_ERROR	Constant	Public	☐	Type reference (TYPE)	SIGN_VSTATE	'4'	Invalid Signature	20011024
11	CO_SIGNED	Constant	Public	☐	Type reference (TYPE)	SIGN_ACTION	'S'	Signature Executed	20010925
12	CO_SIGNER_ERROR	Constant	Public	☐	Type reference (TYPE)	SIGN_VSTATE	'6'	Incorrect Signatory	20011024
13	CO_STATE_PROC_CANC	Constant	Public	☐	Type reference (TYPE)	SIGN_STATE	'2'	Signature Process Cancelled	20020118
14	CO_STATE_PROC_CLOSED	Constant	Public	☐	Type reference (TYPE)	SIGN_STATE	'1'	Digital Signature: Status of the Signature Procedure	20020118
15	CO_STATE_PROC_NEW	Constant	Public	☐	Type reference (TYPE)	SIGN_STATE	' '	New Signature Process Opened	20020118
16	CO_STATE_PROC_OPEN	Constant	Public	☐	Type reference (TYPE)	SIGN_STATE	'3'	Current Signature Process	20020118
17	CO_SYS_ERROR	Constant	Public	☐	Type reference (TYPE)	SIGN_VSTATE	'1'	Error during Verification Operation	20011024
18	CO_VERIFY_OK	Constant	Public	☐	Type reference (TYPE)	SIGN_VSTATE	'0'	Verification Successful	20011024
19	CO_VORBIDDEN	Constant	Public	☐	Type reference (TYPE)	FLAG	'V'	Disallowed	20010906
20	MV_STRATEGY_IS_SYNCHRONOUS	Instance attribute	Public	☐	Type reference (TYPE)	ABAP_BOOL		'X' = Synchronous Strategy	20071008

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_COMMENT	Instance method	Public	Method	Check Comment on Digital Signature	20020409
2	GET_DEFAULT_REMARK_ID	Instance method	Public	Method	Read Proposal Remark for Signature	20060110
3	GET_DOCUMENT	Instance method	Public	Method	Get Document	20010912
4	GET_METHOD	Instance method	Public	Method	Read Short Text For Signature Method	20011024
5	GET_REASON	Instance method	Public	Method	Read Reason for Signature	20010828
6	GET_REMARKS	Instance method	Public	Method	Read Comment for Signature	20010828
7	GET_SIGNED_STEPS	Instance method	Public	Method	Read Previously Executed Signatures	20010828
8	GET_SIGNER	Instance method	Public	Method	Read Preassigned Signatory	20010828
9	GET_STEPS	Instance method	Public	Method	Read Current Signature Step for Signature Strategy	20010828
10	IS_CANCELLED_ALLOWED	Instance method	Public	Method	Simple Cancelation Allowed	20010926
11	IS_COMMENT_REQUIRED	Instance method	Public	Method	Comment is Required	20010828
12	IS_DOCUMENT_DISPLAYED	Instance method	Public	Method	Document is Displayed on the Signature Dialog Box	20010828
13	IS_REASON_DISPLAYED	Instance method	Public	Method	Signature Reasons are Displayed	20010907
14	IS_REMARK_DISPLAYED	Instance method	Public	Method	Digital Signature Remarks are Displayed	20010907
15	IS_USER_CHANGEABLE	Instance method	Public	Method	Field for Signatory is Ready for Input on Sig. Dialog Box	20010828
16	IS_VERIFY_ALLOWED	Instance method	Public	Method	Checks if Verification is Necessary	20011026
17	SET_COMMAND	Instance method	Public	Method	Copy Command from the Screen	20010907
18	SET_COMMENT	Instance method	Public	Method	Copy Comment for Digital Signature	20010907
19	SET_PASSWORD	Instance method	Public	Method	Transfer Password to the Runtime	20010828
20	SET_REMARK	Instance method	Public	Method	Return Selected Remark for Digital Signature	20010906
21	SET_SIGNER	Instance method	Public	Method	Transfer Signatory to the Runtime	20010828
22	SET_SIGN_TIME	Instance method	Public	Method	Transfer Signature Time to the Runtime	20010828
23	SET_STEP	Instance method	Public	Method	Selected Signature Step within the Signature Strategy	20010919

Events

Interface IF_DS_SCREEN_HANDLER has no event.

Types

Interface IF_DS_SCREEN_HANDLER has no local type.

Method Signatures

Method CHECK_COMMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_COMMENT	Call by reference	☐	Type reference (TYPE)	STRING		Kommentar zur Digitalen Signatur	20020409
2	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	BOOLE_D		'X': Kommentar wurde erfasst	20020409

Method CHECK_COMMENT on Interface IF_DS_SCREEN_HANDLER has no exception.

Method GET_DEFAULT_REMARK_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_REMARK_STRUC-ID		Bemerkung (ID), welche als Vorschlag (Listbox) gesetzt wird	20060110

Method GET_DEFAULT_REMARK_ID on Interface IF_DS_SCREEN_HANDLER has no exception.

Method GET_DOCUMENT 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 als binärer file	20010912
2	Exporting	EX_DOC_MTYPE	Call by reference	☐	Type reference (TYPE)	SIGN_STYPE		MIMETyp des zu unterz. Dokuments	20011214
3	Exporting	EX_DOC_TXT	Call by reference	☐	Type reference (TYPE)	STRING		Dokument als Text	20010912
4	Exporting	EX_DOC_TYPE	Call by reference	☐	Type reference (TYPE)	SSFTYPE		SSF Typbezeichner	20010912

Method GET_DOCUMENT on Interface IF_DS_SCREEN_HANDLER has no exception.

Method GET_METHOD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_METHOD	Call by reference	☐	Type reference (TYPE)	SIGN_METHOD		Auswahl der Unterschriftsmethode	20011024
2	Exporting	EX_METHOD_TXT	Call by reference	☐	Type reference (TYPE)	DDTEXT		Kurztext zur Signaturmethode	20011024

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

Method GET_REASON Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	SIGN_REASON		Signaturgrund zur Digitalen Signatur	20010906

Method GET_REASON on Interface IF_DS_SCREEN_HANDLER has no exception.

Method GET_REMARKS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	SIGN_REMARK_TAB		Satz von Bemerkungen aus der Anwendung zur Digit. Signatur	20010907

Method GET_REMARKS on Interface IF_DS_SCREEN_HANDLER has no exception.

Method GET_SIGNED_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)	SIGN_FLAG2		Ausführung der Signaturverifikation	20011019
2	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	SIGN_STEP_POST_TAB		Informationen zu geleisteten Signaturen	20010924

#	Exception	Resumable	Description	Created on
1	CX_DS_CONTEXT	☐	Dokument wurde nicht erzeugt	20011205
2	CX_DS_EXCEPTION	☐	Basisklasse: Alle Ausnahmen zur Digitale Signatur	20011205
3	CX_DS_REGISTRY	☐	Fehlerhafte Registrierung eines Signaturobjektes	20011130

Method GET_SIGNER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_NAMEF	Call by reference	☐	Type reference (TYPE)	XUNAME1		Vorname des Benutzers innerhalb der Firma	20011011
2	Exporting	EX_NAMEL	Call by reference	☐	Type reference (TYPE)	XUNAME1		Nachname des Benutzers innerhalb der Firma	20011011
3	Exporting	EX_SIGNER	Call by reference	☐	Type reference (TYPE)	SIGN_USERID		Name des Signierers, der das Objekt hinzugefügt hat	20011011

Method GET_SIGNER on Interface IF_DS_SCREEN_HANDLER has no exception.

Method GET_STEPS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	SIGN_STEP_PRED_TAB		Informationen über zu leistende Signaturen	20010913

Method GET_STEPS on Interface IF_DS_SCREEN_HANDLER has no exception.

Method IS_CANCELLED_ALLOWED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	SIGN_FLAG2		Kennzeichen mit zwei Zuständen	20010926

Method IS_CANCELLED_ALLOWED on Interface IF_DS_SCREEN_HANDLER has no exception.

Method IS_COMMENT_REQUIRED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	SIGN_COMM_DISP		Kennzeichen mit drei Zuständen	20010904

Method IS_COMMENT_REQUIRED on Interface IF_DS_SCREEN_HANDLER has no exception.

Method IS_DOCUMENT_DISPLAYED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	SIGN_FLAG3		Kennzeichen mit drei Zuständen	20010904

Method IS_DOCUMENT_DISPLAYED on Interface IF_DS_SCREEN_HANDLER has no exception.

Method IS_REASON_DISPLAYED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	SIGN_FLAG2		Kennzeichen mit zwei Zuständen	20010907

Method IS_REASON_DISPLAYED on Interface IF_DS_SCREEN_HANDLER has no exception.

Method IS_REMARK_DISPLAYED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	SIGN_FLAG3		Kennzeichen mit drei Zuständen	20010907

Method IS_REMARK_DISPLAYED on Interface IF_DS_SCREEN_HANDLER has no exception.

Method IS_USER_CHANGEABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	SIGN_FLAG2		Kennzeichen mit zwei Zuständen	20010904

Method IS_USER_CHANGEABLE on Interface IF_DS_SCREEN_HANDLER has no exception.

Method IS_VERIFY_ALLOWED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	SIGN_FLAG2		Verifikation erlaubt/nicht erlaubt	20011026

Method IS_VERIFY_ALLOWED on Interface IF_DS_SCREEN_HANDLER has no exception.

Method SET_COMMAND Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_COMMAND	Call by reference	☐	Type reference (TYPE)	SIGN_ACTION		Menu Painter: Funktionscode	20010907

Method SET_COMMAND on Interface IF_DS_SCREEN_HANDLER has no exception.

Method SET_COMMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_COMMENT	Call by reference	☐	Type reference (TYPE)	STRING		Kommentar zur Digitalen Signatur	20010907

Method SET_COMMENT on Interface IF_DS_SCREEN_HANDLER has no exception.

Method SET_PASSWORD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_PASSWORD	Call by reference	☐	Type reference (TYPE)	SSFPW		SSF Passwort	20010906

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

Method SET_REMARK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_REMARK	Call by reference	☐	Type reference (TYPE)	SIGN_REMARK_STRUC		Bemerkung zur Digitalen Signatur	20010906

Method SET_REMARK on Interface IF_DS_SCREEN_HANDLER has no exception.

Method SET_SIGNER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_NAMEF	Value transfer	☐	Type reference (TYPE)	XUNAME1		Vorname des Benutzers innerhalb der Firma	20011011
2	Exporting	EX_NAMEL	Value transfer	☐	Type reference (TYPE)	XUNAME1		Nachname des Benutzers innerhalb der Firma	20011011
3	Importing	IM_SIGNER	Call by reference	☐	Type reference (TYPE)	SIGN_USERID		Name des Signierers, der das Objekt hinzugefügt hat	20010906

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

Method SET_SIGN_TIME Signature

Method SET_SIGN_TIME on Interface IF_DS_SCREEN_HANDLER has no parameter.
Method SET_SIGN_TIME on Interface IF_DS_SCREEN_HANDLER has no exception.

Method SET_STEP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_STEP	Call by reference	☐	Type reference (TYPE)	SIGNAUTH		Informationen über zu leistende Signaturen	20010919

Method SET_STEP on Interface IF_DS_SCREEN_HANDLER has no exception.

History

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