SAP ABAP Class CL_GRFN_OWP_HANDLER_BASE (Base class for PDF handler)

Hierarchy

☛ GRCFND_A (Software Component) GRC Foundation ABAP
   ⤷ GRC (Application Component) Governance, Risk and Compliance
     ⤷ GRFN_WORKFLOW (Package) GRC Workflow Inbox and feeder classes

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_GRFN_OWP_HANDLER_MANUTEST	OWP handler for manual test	20100914
2	Inheritance (c INHERITING FROM c_ref)	CL_GRPC_AIF_HANDLER_ASSESSMENT	Handler Class for Assessment AIF	20110110
3	Inheritance (c INHERITING FROM c_ref)	CL_GRPC_AIF_HANDLER_DISCSVY	AIF handler for disclosure survey	20120524
4	Inheritance (c INHERITING FROM c_ref)	CL_GRPC_AIF_HANDLER_TESTLOG	Handler Class for Testlog AIF	20110110
5	Inheritance (c INHERITING FROM c_ref)	CL_GRPC_AIF_HANDLER_TEST_AUTO	Handler Class for Auto Testing AIF	20110110

Properties

Class	CL_GRFN_OWP_HANDLER_BASE
Short Description	Base class for PDF handler
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	GRFN_WORKFLOW	GRC Workflow Inbox and feeder classes
Created	20100906	SAP
Last change	20141106
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_GRFN_OWP_HANDLER_BASE has no forward declaration.

Interfaces

Class CL_GRFN_OWP_HANDLER_BASE has no interface implemented.

Friends

#	Friend	Modeled only	Created on	Description
1	CL_GRFN_OWP_DELIVER	☐	20100914	Offline Working Process deliver

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CV_CLASSNAME	Constant	Private	☐	Type reference (TYPE)	GRFN_CLASS_NAME	'CL_GRFN_OWP_HANDLER_BASE'	Class Name	20110105
2	MO_APPLOG	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_GRFN_APPLOG_OWP		GRC Offline Working Process Logging	20110104
3	MO_SESSION	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_GRFN_API_SESSION		Session Management for GRC APIs	20100915
4	MS_HANDLE_RETURN	Instance attribute	Protected	☐	Type reference (TYPE)	GRPC_S_AIF_HANDLE_RETURN		Used Only Need The Return Value After Handling PDF	20110623

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	BUILD_PDF_ATTACHMENTS	Instance method	Protected	Method	[Outbound] Add attachment into PDF file	20101015
2	BUILD_PDF_BY_WIID	Instance method	Protected	Method	[Outbound] Build PDF Form by work item ID	20120612
3	BUILD_PDF_FORM	Instance method	Protected	Method	[Outbound] Build PDF form	20100906
4	CONSTRUCTOR	Instance method	Public	Constructor		20100915
5	DELIVER	Instance method	Protected	Method	[Outbound] Trigger deliver	20100914
6	GET_HANDLE_RETURN	Instance method	Public	Method	Get Return Value After Handling PDF	20110623
7	GET_HISTORY	Instance method	Protected	Method	[Outbound] Get history for assessment	20120612
8	GET_SENDER_MAIL	Static method	Public	Method	[Outbound] Get sender email address	20101210
9	GET_SENDER_UNAME	Static method	Public	Method	[Outbound] Get sender name	20101209
10	LOAD_ATTACHMENTS	Instance method	Protected	Method	Load attachment	20110328
11	RESET_SESSION_FOR_HISTORY	Instance method	Private	Method	[Outbound] Create Session for Previous history	20120209
12	SAVE_ATTACHMENTS	Instance method	Public	Method	[Inbound] Check and Save attachment in PDF	20110223
13	SAVE_OBJECT_ATTACHMENTS	Instance method	Public	Method	Save attachment for object	20120618
14	SEND_PDF_FORM	Instance method	Protected	Method	[Outbound] Send PDF by mail	20100914
15	SEND_REPLICATED_BACK	Instance method	Private	Method	[Inbound] If duplicated workitem inbound, send back	20100914
16	SET_HANDLE_RETURN	Instance method	Public	Method	Set Return Value When Handling PDF	20110623
17	SET_SEND_MSG	Instance method	Protected	Method	[Outbound] Set related information In sent Email	20120209
18	TEST	Instance method	Public	Method		20101015

Events

Class CL_GRFN_OWP_HANDLER_BASE has no event.

Types

Class CL_GRFN_OWP_HANDLER_BASE has no local type.

Method Signatures

Method BUILD_PDF_ATTACHMENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CS_FORMOUTPUT	Call by reference	☐	Type reference (TYPE)	FPFORMOUTPUT		Form Output (PDF, PDL)	20101015
2	Importing	IT_OVER_SIZE_DOC_LIST	Call by reference	☑	Type reference (TYPE)	GRFN_T_API_DOCUMENT_LIST		The list of the documents	20120209
3	Importing	IV_API_OBJ	Value transfer	☐	Type reference (TYPE)	GRPC_API_OBJECT_ID			20101015
4	Importing	IV_REGULATION	Value transfer	☐	Type reference (TYPE)	GRPC_API_OBJECT_ID			20101015

#	Exception	Resumable	Description	Created on
1	CX_GRFN_EXCEPTION	☐	Generic GRC API exception	20110222

Method BUILD_PDF_BY_WIID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_FPFORMOUTPUT	Call by reference	☐	Type reference (TYPE)	FPFORMOUTPUT		Form Output (PDF, PDL)	20120612
2	Importing	IV_FORMNAME	Call by reference	☐	Type reference (TYPE)	FPNAME		Name of Form Object	20120612
3	Importing	IV_WI_ID	Call by reference	☐	Type reference (TYPE)	SWW_WIID		Work item ID	20120612

#	Exception	Resumable	Description	Created on
1	CX_GRFN_EXCEPTION	☐	Generic GRC API exception	20120612

Method BUILD_PDF_FORM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_FPFORMOUTPUT	Call by reference	☐	Type reference (TYPE)	FPFORMOUTPUT		Form Processing: Content from XFT, XFD, PDF, and so on	20101018
2	Importing	IS_BASE_INFO	Call by reference	☐	Type reference (TYPE)	GRFN_S_OWP_BASE_INFO		Base Info Structure for OWP	20110124

#	Exception	Resumable	Description	Created on
1	CX_GRFN_EXCEPTION	☐	Generic GRC API exception	20101018

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_MSGID	Value transfer	☐	Type reference (TYPE)	SY-MSGID	'GRFN_OWP'	Message Class	20110104
2	Importing	IV_WF_ID	Value transfer	☐	Type reference (TYPE)	SWW_WIID		Work item ID	20120209

#	Exception	Resumable	Description	Created on
1	CX_GRFN_EXCEPTION	☐	Generic GRC API exception	20110905

Method DELIVER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FORMNAME	Value transfer	☐	Type reference (TYPE)	FPNAME		Name of Form Object	20110307
2	Importing	IV_WI_ID	Value transfer	☐	Type reference (TYPE)	SWW_WIID		Work item ID	20100914

#	Exception	Resumable	Description	Created on
1	CX_GRFN_EXCEPTION	☐	Generic GRC API exception	20101018

Method GET_HANDLE_RETURN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RS_HANDLE_RETURN	Value transfer	☐	Type reference (TYPE)	GRPC_S_AIF_HANDLE_RETURN		Exporting value structure after handling PDF	20110623

Method GET_HANDLE_RETURN on class CL_GRFN_OWP_HANDLER_BASE has no exception.

Method GET_HISTORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_HISTORY	Call by reference	☐	Type reference (TYPE)	GRPC_T_AIF_FPFORMOUTPUT		Table For multi-PDF Sending IN AIF	20120612
2	Importing	IV_FORMNAME	Call by reference	☐	Type reference (TYPE)	FPNAME		Name of Form Object	20120612
3	Importing	IV_WI_ID	Call by reference	☐	Type reference (TYPE)	SWW_WIID		Work item ID	20120612

#	Exception	Resumable	Description	Created on
1	CX_GRFN_EXCEPTION	☐	Generic GRC API exception	20120612

Method GET_SENDER_MAIL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_EMAIL	Value transfer	☐	Type reference (TYPE)	AD_SMTPADR		E-Mail Address	20101210

#	Exception	Resumable	Description	Created on
1	CX_GRFN_EXCEPTION	☐	Generic GRC API exception	20110216

Method GET_SENDER_UNAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_SENDER	Value transfer	☐	Type reference (TYPE)	UNAME		User Name	20101209

#	Exception	Resumable	Description	Created on
1	CX_GRFN_EXCEPTION	☐	Generic GRC API exception	20110216

Method LOAD_ATTACHMENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_DOC_LIST	Call by reference	☐	Type reference (TYPE)	GRFN_T_API_DOCUMENT_LIST		The list of the documents	20110328
2	Importing	IV_API_OBJ_ID	Call by reference	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20110328
3	Importing	IV_REGULATION_ID	Call by reference	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20110328

#	Exception	Resumable	Description	Created on
1	CX_GRFN_EXCEPTION	☐	Generic GRC API exception	20110328

Method RESET_SESSION_FOR_HISTORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CASE_ID	Value transfer	☐	Type reference (TYPE)	GRPC_API_OBJECT_ID		GRPC ID of the individual object	20120209

#	Exception	Resumable	Description	Created on
1	CX_GRFN_EXCEPTION	☐	Generic GRC API exception	20120209

Method SAVE_ATTACHMENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_HANDLER	Call by reference	☐	Object reference (TYPE REF TO)	CL_GRFN_OWP_HANDLER_BASE		Base class for PDF handler	20110329
2	Importing	IO_SESSION	Call by reference	☐	Object reference (TYPE REF TO)	CL_GRFN_API_SESSION		Session Management for GRC APIs	20110328
3	Importing	IT_ATTACHMENT	Call by reference	☐	Type reference (TYPE)	TFPATTACHMENTS		Attachment List	20110328
4	Importing	IV_WI_ID	Call by reference	☐	Type reference (TYPE)	SWW_WIID		Object ID	20110328

#	Exception	Resumable	Description	Created on
1	CX_GRFN_EXCEPTION	☐	Generic GRC API exception	20110223

Method SAVE_OBJECT_ATTACHMENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_HANDLER	Call by reference	☐	Object reference (TYPE REF TO)	CL_GRFN_OWP_HANDLER_BASE		Base class for PDF handler	20120618
2	Importing	IO_SESSION	Call by reference	☐	Object reference (TYPE REF TO)	CL_GRFN_API_SESSION		Session Management for GRC APIs	20120618
3	Importing	IT_ATTACHMENT	Call by reference	☐	Type reference (TYPE)	TFPATTACHMENTS		Attachment List	20120618
4	Importing	IV_OBJECT	Call by reference	☐	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20120618
5	Importing	IV_REGULATION	Call by reference	☑	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20120621

#	Exception	Resumable	Description	Created on
1	CX_GRFN_EXCEPTION	☐	Generic GRC API exception	20120618

Method SEND_PDF_FORM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_ATTACHMENT	Call by reference	☑	Type reference (TYPE)	GRFN_T_NOTIFICATION_ATTACHMENT		Notification Attachments	20120612
2	Importing	IT_RECIPIENT	Call by reference	☑	Type reference (TYPE)	GRFN_T_RECIPIENT_USER		Recipients defined by user name	20140507
3	Importing	IV_HISTORY_PDF	Call by reference	☑	Type reference (TYPE)	GRPC_T_AIF_FPFORMOUTPUT		Table For multi-PDF Sending IN AIF	20110719
4	Importing	IV_PDF	Call by reference	☐	Type reference (TYPE)	FPCONTENT		Form Processing: Content from XFT, XFD, PDF, and so on	20101018
5	Importing	IV_WI_ID	Value transfer	☐	Type reference (TYPE)	SWW_WIID		Work item ID	20101018

#	Exception	Resumable	Description	Created on
1	CX_GRFN_EXCEPTION	☐	Generic GRC API exception	20110105

Method SEND_REPLICATED_BACK Signature

Method SEND_REPLICATED_BACK on class CL_GRFN_OWP_HANDLER_BASE has no parameter.
Method SEND_REPLICATED_BACK on class CL_GRFN_OWP_HANDLER_BASE has no exception.

Method SET_HANDLE_RETURN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_HANDLE_RETURN	Call by reference	☐	Type reference (TYPE)	GRPC_S_AIF_HANDLE_RETURN		Exporting value structure after handling PDF	20110623

Method SET_HANDLE_RETURN on class CL_GRFN_OWP_HANDLER_BASE has no exception.

Method SET_SEND_MSG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_SEND_MSG	Call by reference	☐	Type reference (TYPE)	GRFN_S_MSG_VARIABLE		Variables used in notifications	20120209

Method SET_SEND_MSG on class CL_GRFN_OWP_HANDLER_BASE has no exception.

Method TEST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_FPRESULT	Call by reference	☐	Type reference (TYPE)	FPFORMOUTPUT		Form Processing: Content from XFT, XFD, PDF, and so on	20101018
2	Importing	IV_WI_ID	Call by reference	☐	Type reference (TYPE)	SWW_WIID		Work item ID	20101015

#	Exception	Resumable	Description	Created on
1	CX_GRFN_EXCEPTION	☐	Generic GRC API exception	20110216

History

Last changed by/on	SAP	20141106
SAP Release Created in	V1000