SAP ABAP Class CL_PDF_FORM_BCS (PDF-Based Form)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-COM (Application Component) Communication Services: Mail, Fax, SMS, Telephony
     ⤷ SBCOMS (Package) Business Communication Service

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_COPY_BCS	Copy Instances	20040319
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_COVER_PAGE_BCS	Cover Sheet Interface for Send Request	20040319
3	Interface implementation (CLASS c. INTERFACES i_ref)	IF_DELETE_BCS	BCS: Deletion Functions	20040319
4	Interface implementation (CLASS c. INTERFACES i_ref)	IF_DOCUMENT_BCS	Document Interface for BCS	20040319
5	Interface implementation (CLASS c. INTERFACES i_ref)	IF_DOCUMENT_BCS_PPF	PPF: Document Within BCS Medium	20040415
6	Interface implementation (CLASS c. INTERFACES i_ref)	IF_OS_STATE	State Management for a 'Managed Object'	20040319
7	Interface implementation (CLASS c. INTERFACES i_ref)	IF_PERSONALIZE_BCS	Variable Replacement for Personalized Mails	20040319

Properties

Class	CL_PDF_FORM_BCS
Short Description	PDF-Based Form
Super Class
Instantiability of a Class	1	Protected
Final	☑

General Data

Message Class
Program status
Category	10	Persistent Class
Package	SBCOMS	Business Communication Service
Created	20040319	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	CL_OS_SYSTEM	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_COPY_BCS	☐	☐	Copy Instances	20040319
2	IF_COVER_PAGE_BCS	☐	☐	Cover Sheet Interface for Send Request	20040319
3	IF_DELETE_BCS	☐	☐	BCS: Deletion Functions	20040319
4	IF_DOCUMENT_BCS	☐	☐	Document Interface for BCS	20040319
5	IF_DOCUMENT_BCS_PPF	☐	☐	PPF: Document Within BCS Medium	20040415
6	IF_OS_STATE	☐	☐	State Management for a 'Managed Object'	20040319
7	IF_PERSONALIZE_BCS	☐	☐	Variable Replacement for Personalized Mails	20040319

Friends

#	Friend	Modeled only	Created on	Description
1	CB_PDF_FORM_BCS	☐	20040319	PDF-Based Form: Base Agent

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CV_REC	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_CAM_ADDRESS_BCS		Cover Sheet: Recipient	20040319
2	CV_SND	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_CAM_ADDRESS_BCS		Cover Sheet: Sender	20040319
3	FORMNAME	Instance attribute	Protected	☐	Type reference (TYPE)	TDSFNAME		Form Name	20040319
4	PERSONALIZ	Instance attribute	Protected	☐	Type reference (TYPE)	CHAR1		Type of Personalization	20040319
5	SFPROCESS	Instance attribute	Protected	☐	Type reference (TYPE)	BCSDFLTVAL		Filter Value for BADI DOC_PERSONALIZE_BCS	20040319

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CALL_BADI_PDF_DOC_PDFIF	Instance method	Protected	Method	Calls PERSONALIZE_PDF_DOC_SFIF	20040413
2	CALL_BADI_PDF_DOC_SFIF	Instance method	Protected	Method	Calls PERSONALIZE_PDF_DOC_SFIF	20040402
3	CLASS_CONSTRUCTOR	Static method	Public	Constructor	CLASS_CONSTRUCTOR	20040414
4	CREATE	Static method	Public	Method	Creates a New Instance	20040319
5	GETU_ATTACHMENTS	Instance method	Public	Method	Read Attachment for a Document in Send Request	20101006
6	GET_CV_REC	Instance method	Public	Get-method of a virtual attribute	Reads Attribute CV_REC	20040319
7	GET_CV_SND	Instance method	Public	Get-method of a virtual attribute	Reads Attribute CV_SND	20040319
8	GET_FORMNAME	Instance method	Public	Get-method of a virtual attribute	Gets Attribute FORMNAME	20040319
9	GET_PERSONALIZ	Instance method	Public	Get-method of a virtual attribute	Reads Attribute PERSONALIZ	20040319
10	GET_SFPROCESS	Instance method	Public	Get-method of a virtual attribute	Reads Attribute SFPROCESS	20040319
11	SET_CV_REC	Instance method	Public	Set-method of a virtual attribute	Sets Attribute CV_REC	20040319
12	SET_CV_SND	Instance method	Public	Set-method of a virtual attribute	Sets Attribute CV_SND	20040319
13	SET_FORMNAME	Instance method	Public	Set-method of a virtual attribute	Sets Attribute FORMNAME	20040319
14	SET_PERSONALIZ	Instance method	Public	Set-method of a virtual attribute	Sets Attribute PERSONALIZ	20040319
15	SET_SFPROCESS	Instance method	Public	Set-method of a virtual attribute	Sets Attribute SFPROCESS	20040319
16	TSFOTF_TO_XSTRING	Static method	Public	Method	Transforms OTF Table into XSTRING	20040503
17	WRAPPER	Instance method	Private	Method	Reads Document Wrapper	20101011

Events

Class CL_PDF_FORM_BCS has no event.

Types

Class CL_PDF_FORM_BCS has no local type.

Method Signatures

Method CALL_BADI_PDF_DOC_PDFIF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	APPL	Call by reference	☐	Object reference (TYPE REF TO)	OBJECT		Anwendungsobjekt	20040413
2	Importing	APPLICATION_LOG	Call by reference	☐	Type reference (TYPE)	BALLOGHNDL		Verarbeitungsprotokoll	20040413
3	Changing	ARCHIVE_INDEX	Call by reference	☐	Type reference (TYPE)	TSFDARA		Tabelle mit Archivindizes	20040413
4	Importing	ARCHIVE_MODE	Call by reference	☐	Type reference (TYPE)	PPFDBCSARC		Ablagemodus: zusätzlich/exklusiv/nicht archivieren	20040413
5	Importing	ARCHIVE_PARAMETER	Call by reference	☐	Type reference (TYPE)	ARC_PARAMS		Archivparameter	20040413
6	Importing	COMMTYPE	Call by reference	☐	Type reference (TYPE)	BCSDCOMTYP		Kommunikationsart für BCS Medium	20040413
7	Exporting	DOCUMENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_DOCUMENT_BCS		Personalisiertes Dokument	20040413
8	Importing	IP_FUNCTION_NAME	Call by reference	☐	Type reference (TYPE)	RS38L_FNAM		Funktionsbausteins des PDF-Formulars	20040413
9	Importing	NO_ATTACHMENTS	Call by reference	☑	Type reference (TYPE)	CHAR1		Keine Anlagen anfügen	20101011
10	Importing	PERSONALIZE_DATA	Call by reference	☐	Object reference (TYPE REF TO)	CL_PERSONALIZE_DATA_BCS		Serviceklasse für die Personalisierung eines Mails	20040413
11	Importing	PREVIEW	Call by reference	☐	Type reference (TYPE)	CHAR1		X = Preview	20040413
12	Importing	SPOOLDATA	Call by reference	☐	Type reference (TYPE)	PPFSIBCSTP		Drucker-/Spooldaten	20040413
13	Exporting	STATUS	Call by reference	☐	Type reference (TYPE)	PPFDTSTAT		Verarbeitungsstatus	20040413
14	Importing	TECHNICAL_RECIPIENT	Call by reference	☐	Type reference (TYPE)	SWOTOBJID		Empfänger (für Transport/Gerätetyp)	20040413

Method CALL_BADI_PDF_DOC_PDFIF on class CL_PDF_FORM_BCS has no exception.

Method CALL_BADI_PDF_DOC_SFIF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	APPL	Call by reference	☐	Object reference (TYPE REF TO)	OBJECT		Anwendungsobjekt	20040402
2	Importing	APPLICATION_LOG	Call by reference	☐	Type reference (TYPE)	BALLOGHNDL		Verarbeitungsprotokoll	20040402
3	Changing	ARCHIVE_INDEX	Call by reference	☐	Type reference (TYPE)	TSFDARA		Tabelle mit Archivindizes	20040402
4	Importing	ARCHIVE_MODE	Call by reference	☐	Type reference (TYPE)	PPFDBCSARC		Ablagemodus: zusätzlich/exklusiv/nicht archivieren	20040402
5	Importing	ARCHIVE_PARAMETER	Call by reference	☐	Type reference (TYPE)	ARC_PARAMS		Archivparameter	20040402
6	Importing	COMMTYPE	Call by reference	☐	Type reference (TYPE)	BCSDCOMTYP		Kommunikationsart für BCS Medium	20040402
7	Exporting	DOCUMENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_DOCUMENT_BCS		Personalisiertes Dokument	20040402
8	Importing	IP_FUNCTION_NAME	Call by reference	☐	Type reference (TYPE)	RS38L_FNAM		Funktionsbausteins des PDF-Formulars	20040413
9	Importing	NO_ATTACHMENTS	Call by reference	☑	Type reference (TYPE)	CHAR1		Keine Anlagen anfügen	20101011
10	Importing	PERSONALIZE_DATA	Call by reference	☐	Object reference (TYPE REF TO)	CL_PERSONALIZE_DATA_BCS		Serviceklasse für die Personalisierung eines Mails	20040402
11	Importing	PREVIEW	Call by reference	☐	Type reference (TYPE)	CHAR1		X = Preview	20040402
12	Importing	SPOOLDATA	Call by reference	☐	Type reference (TYPE)	PPFSIBCSTP		Drucker-/Spooldaten	20040402
13	Exporting	STATUS	Call by reference	☐	Type reference (TYPE)	PPFDTSTAT		Verarbeitungsstatus	20040402
14	Importing	TECHNICAL_RECIPIENT	Call by reference	☐	Type reference (TYPE)	SWOTOBJID		Empfänger (für Transport/Gerätetyp)	20040402

Method CALL_BADI_PDF_DOC_SFIF on class CL_PDF_FORM_BCS has no exception.

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class CL_PDF_FORM_BCS has no parameter.
Method CLASS_CONSTRUCTOR on class CL_PDF_FORM_BCS has no exception.

Method CREATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FORMNAME	Value transfer	☐	Type reference (TYPE)	TDSFNAME		Formularname	20040319
2	Importing	PERSONALIZ	Value transfer	☑	Type reference (TYPE)	CHAR1		Art der Personalisierung	20040319
3	Returning	RESULT	Value transfer	☐	Object reference (TYPE REF TO)	CL_PDF_FORM_BCS		Neue Instanz	20040319
4	Importing	SFPROCESS	Value transfer	☑	Type reference (TYPE)	BCSDFLTVAL		Filterwert für BADI DOC_PERSONALIZE_BCS	20040319

Method CREATE on class CL_PDF_FORM_BCS has no exception.

Method GETU_ATTACHMENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_ATTACHMENTS	Value transfer	☐	Type reference (TYPE)	BCSY_IFDOC		tabelle von IF_DOCUMENT_BCS	20101006

Method GETU_ATTACHMENTS on class CL_PDF_FORM_BCS has no exception.

Method GET_CV_REC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RESULT	Value transfer	☐	Object reference (TYPE REF TO)	CL_CAM_ADDRESS_BCS		Attributwert	20040319

#	Exception	Resumable	Description	Created on
1	CX_OS_OBJECT_NOT_FOUND	☐	Object Services Exception	20040319

Method GET_CV_SND Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RESULT	Value transfer	☐	Object reference (TYPE REF TO)	CL_CAM_ADDRESS_BCS		Attributwert	20040319

#	Exception	Resumable	Description	Created on
1	CX_OS_OBJECT_NOT_FOUND	☐	Object Services Exception	20040319

Method GET_FORMNAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	TDSFNAME		Attributwert	20040319

#	Exception	Resumable	Description	Created on
1	CX_OS_OBJECT_NOT_FOUND	☐	Object Services Exception	20040319

Method GET_PERSONALIZ Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	CHAR1		Attributwert	20040319

#	Exception	Resumable	Description	Created on
1	CX_OS_OBJECT_NOT_FOUND	☐	Object Services Exception	20040319

Method GET_SFPROCESS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	BCSDFLTVAL		Attributwert	20040319

#	Exception	Resumable	Description	Created on
1	CX_OS_OBJECT_NOT_FOUND	☐	Object Services Exception	20040319

Method SET_CV_REC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CV_REC	Call by reference	☐	Object reference (TYPE REF TO)	CL_CAM_ADDRESS_BCS		Attributwert	20040319

#	Exception	Resumable	Description	Created on
1	CX_OS_OBJECT_NOT_FOUND	☐	Object Services Exception	20040319

Method SET_CV_SND Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CV_SND	Call by reference	☐	Object reference (TYPE REF TO)	CL_CAM_ADDRESS_BCS		Attributwert	20040319

#	Exception	Resumable	Description	Created on
1	CX_OS_OBJECT_NOT_FOUND	☐	Object Services Exception	20040319

Method SET_FORMNAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_FORMNAME	Call by reference	☐	Type reference (TYPE)	TDSFNAME		Attributwert	20040319

#	Exception	Resumable	Description	Created on
1	CX_OS_OBJECT_NOT_FOUND	☐	Object Services Exception	20040319

Method SET_PERSONALIZ Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_PERSONALIZ	Call by reference	☐	Type reference (TYPE)	CHAR1		Attributwert	20040319

#	Exception	Resumable	Description	Created on
1	CX_OS_OBJECT_NOT_FOUND	☐	Object Services Exception	20040319

Method SET_SFPROCESS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_SFPROCESS	Call by reference	☐	Type reference (TYPE)	BCSDFLTVAL		Attributwert	20040319

#	Exception	Resumable	Description	Created on
1	CX_OS_OBJECT_NOT_FOUND	☐	Object Services Exception	20040319

Method TSFOTF_TO_XSTRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_TSFOTF	Call by reference	☐	Type reference (TYPE)	TSFOTF		OTF-Tabelle (mit XSTRING gefüllt!)	20040503
2	Returning	RP_XSTRING	Value transfer	☐	Type reference (TYPE)	XSTRING		XSTRING	20040503

Method TSFOTF_TO_XSTRING on class CL_PDF_FORM_BCS has no exception.

Method WRAPPER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RESULT	Value transfer	☐	Object reference (TYPE REF TO)	CL_DOCUMENT_BCS		Wrapperklasse für Office-Dokumente	20101011

Method WRAPPER on class CL_PDF_FORM_BCS has no exception.

History

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