SAP ABAP Class CL_FPM_BOL_MODEL (Base Class for FPM UI Building Blocks on BOL)

Hierarchy

☛ WEBCUIF (Software Component) SAP Web UI Framework
   ⤷ CA-UI2-INT-BE (Application Component) Backend Enablement
     ⤷ APB_FPM_BOL_CORE (Package) Bol Adaptation for FPM

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_FPM_BOL_BASE	General Base Class for FPM on BOL	20090422
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_FPM_CHIP_FEEDER	Chip Feeder	20110105
3	Interface implementation (CLASS c. INTERFACES i_ref)	IF_FPM_FEEDER_MODEL	Feeder Model Interface	20090420

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_FPM_BOL_MODEL_ACCESS	Access Class for FPM UI Building Blocks on BOL	20090420
2	Inheritance (c INHERITING FROM c_ref)	CL_GUIBB_BOL_BASE	Generic BOL Feeder Base	20090420

Properties

Class	CL_FPM_BOL_MODEL
Short Description	Base Class for FPM UI Building Blocks on BOL
Super Class	CL_FPM_BOL_BASE	General Base Class for FPM on BOL
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	APB_FPM_BOL_CORE	Bol Adaptation for FPM
Created	20090420	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
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)
2	CL_WD_UIELEMENT	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
3	IF_FPM_FEEDER_MODEL	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
4	IF_FPM_MESSAGE_MANAGER	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_FPM_CHIP_FEEDER	☐	☐	Chip Feeder	20110105
2	IF_FPM_FEEDER_MODEL	☐	☐	Feeder Model Interface	20090420

Friends

Class CL_FPM_BOL_MODEL has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CV_PORT_IDENTIFIER	Constant	Public	☐	Type reference (TYPE)	FPM_MODEL_PORT_IDENTIFIER	'STANDARD'	Port idenitification	20090420
2	MO_CHIP_API	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_CHIP_API		CHIP API	20110105
3	MO_COLLECTION	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_BOL_ENTITY_COL		Bol collection	20090420
4	MO_CONNECTOR	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_FPM_CONNECTOR_RUN		Connector: Runtime	20090420
5	MS_INSTANCE_KEY	Instance attribute	Protected	☐	Type reference (TYPE)	FPM_S_UIBB_INSTANCE_KEY		UIBB Instance Key	20101125
6	MS_OBJECT_KEY	Instance attribute	Public	☑	Type reference (TYPE)	S_OBJECT_KEY		Object key: component and object name	20090420
7	MT_OUTPORT	Instance attribute	Protected	☐	Type reference (TYPE)	IF_FPM_FEEDER_MODEL=>TY_T_PORT		Table of outports	20090420
8	MT_SHOW_MULTI_MESSAGE	Instance attribute	Protected	☐	Type reference (TYPE)	CRMT_GENIL_MESSAGE_TAB		Message Table	20101006
9	MV_INTERFACE_VIEW	Instance attribute	Protected	☐	Type reference (TYPE)	FPM_WINDOW_NAME		Name of a Web Dynpro Window in Floorplan Manager	20101125
10	MV_OBJECT_KIND	Instance attribute	Public	☑	Type reference (TYPE)	CRMT_OBJKIND		Object Type	20090422
11	MV_STRUCT_NAME	Instance attribute	Public	☑	Type reference (TYPE)	STRUKNAME		Name of a structure	20090422

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ACTIVATE_BOL_SENDING	Instance method	Protected	Method	Activates sending on a BOL entity if necessary	20100906
2	CLAIM_GENIL_MESSAGES	Instance method	Protected	Method	Claim GENIL messages for own UIBB	20090420
3	CREATE_ENTITY	Instance method	Protected	Method	Creates a BOL entity	20090422
4	FPM_BOL_IS_REVERT_EVENT	Instance method	Protected	Method	Returns true if the event is a transactional revert	20120803
5	GET_BOL_MODEL_INFO	Instance method	Protected	Method	Get basic info for BOL model	20090422
6	GET_GENIL_MESSAGES	Instance method	Protected	Method	Get all GENIL messages for entity	20090420
7	GET_PORT_DESCRIPTION	Instance method	Protected	Method	Defines descriptive text for an outport	20090420
8	INIT_ROUNDTRIP	Instance method	Protected	Method	Initalizes the FPM event roundtrip	20101006
9	MODIFY_CNR_BUTTON	Instance method	Protected	Method	Modifies a (standard) button in the CNR toolbar	20090603
10	PREPARE_COLLECTION	Instance method	Protected	Method	Prepares the collection	20090420
11	SET_COLLECTION	Instance method	Protected	Method	Sets local collection reference	20090420
12	SET_SIDE_PANEL_LINK	Instance method	Protected	Method	Sets a link for the side panel	20110107
13	SET_UP_PORT	Instance method	Protected	Method	Defines a single port of given type	20090420
14	SET_UP_PORTS	Instance method	Protected	Method	Defines all ports	20090420
15	START_UP	Instance method	Protected	Method	Starts up BOL core	20090422
16	TAP_CONNECTOR	Instance method	Protected	Method	Retrieve BOL collection from connector and prepare	20090420

Events

#	Event	Type	Visibility	Description	Created on
1	MESSAGES_CLAIMED	Instance Event (0)	Public (2)		20090420

Types

Class CL_FPM_BOL_MODEL has no local type.

Method Signatures

Method ACTIVATE_BOL_SENDING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_ENTITY	Call by reference	☐	Object reference (TYPE REF TO)	CL_CRM_BOL_ENTITY		Entity	20100906

Method ACTIVATE_BOL_SENDING on class CL_FPM_BOL_MODEL has no exception.

Method CLAIM_GENIL_MESSAGES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_ENTITY	Call by reference	☐	Object reference (TYPE REF TO)	CL_CRM_BOL_ENTITY		Entity	20090420
2	Importing	IT_GENIL_MESSAGE	Call by reference	☐	Type reference (TYPE)	CRMT_GENIL_MESSAGE_TAB		Message Table	20090420

Method CLAIM_GENIL_MESSAGES on class CL_FPM_BOL_MODEL has no exception.

Method CREATE_ENTITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_CREATE_CONTROL	Call by reference	☑	Type reference (TYPE)	FPM_BOL_ENTITY_CREATE_CONTROL		Create Parameter	20100903
2	Importing	IS_INITIAL_DATA	Call by reference	☐	Type reference (TYPE)	FPM_BOL_INITIAL_DATA		Initial Data for Entity Creation/Derivation with Connector	20090422
3	Returning	RO_ENTITY	Value transfer	☐	Object reference (TYPE REF TO)	CL_CRM_BOL_ENTITY		Entity	20090422

Method CREATE_ENTITY on class CL_FPM_BOL_MODEL has no exception.

Method FPM_BOL_IS_REVERT_EVENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_EVENT	Call by reference	☐	Object reference (TYPE REF TO)	CL_FPM_EVENT		CL_FPM_EVENT	20120803
2	Returning	RV_IS_REVERT_EVENT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20120803

Method FPM_BOL_IS_REVERT_EVENT on class CL_FPM_BOL_MODEL has no exception.

Method GET_BOL_MODEL_INFO Signature

Method GET_BOL_MODEL_INFO on class CL_FPM_BOL_MODEL has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_CRM_GENIL_GENERAL_ERROR	☐	General Exception	20090424

Method GET_GENIL_MESSAGES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_GENIL_MESSAGE	Call by reference	☐	Type reference (TYPE)	CRMT_GENIL_MESSAGE_TAB		Message Table	20090420
2	Importing	IO_ENTITY	Call by reference	☐	Object reference (TYPE REF TO)	CL_CRM_BOL_ENTITY		Entity	20090420
3	Importing	IT_ATTR	Call by reference	☑	Type reference (TYPE)	CRMT_ATTR_NAME_TAB		Table of Attribute Names	20101105

Method GET_GENIL_MESSAGES on class CL_FPM_BOL_MODEL has no exception.

Method GET_PORT_DESCRIPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_PORT_IDENTIFIER	Call by reference	☐	Type reference (TYPE)	FPM_MODEL_PORT_IDENTIFIER		FPM Wire Model: Port Identifier	20090422
2	Importing	IV_PORT_TYPE	Call by reference	☐	Type reference (TYPE)	FPM_MODEL_PORT_TYPE		FPM Wire Model: Port Type	20090420
3	Returning	RV_PORT_DESCRIPTION	Value transfer	☐	Type reference (TYPE)	FPM_MODEL_PORT_DESCRIPTION		FPM Wire Model: Port Description	20090420

Method GET_PORT_DESCRIPTION on class CL_FPM_BOL_MODEL has no exception.

Method INIT_ROUNDTRIP Signature

Method INIT_ROUNDTRIP on class CL_FPM_BOL_MODEL has no parameter.
Method INIT_ROUNDTRIP on class CL_FPM_BOL_MODEL has no exception.

Method MODIFY_CNR_BUTTON Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ENABLED	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20090603
2	Importing	IV_EVENT_ID	Call by reference	☐	Type reference (TYPE)	FPM_EVENT_ID		ID of the FPM Event	20090603
3	Importing	IV_OVP_UIBB_TOOLBAR	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20101125
4	Importing	IV_VISIBILITY	Call by reference	☐	Type reference (TYPE)	WDUI_VISIBILITY	CL_WD_UIELEMENT=>E_VISIBLE-VISIBLE	Web Dynpro: Visibility	20090603

Method MODIFY_CNR_BUTTON on class CL_FPM_BOL_MODEL has no exception.

Method PREPARE_COLLECTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_BO_COL	Call by reference	☐	Object reference (TYPE REF TO)	IF_BOL_BO_COL		Business Object Collection Interface	20090420

Method PREPARE_COLLECTION on class CL_FPM_BOL_MODEL has no exception.

Method SET_COLLECTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_COLLECTION	Call by reference	☐	Object reference (TYPE REF TO)	IF_BOL_ENTITY_COL		Entities Collection Interface	20090420

Method SET_COLLECTION on class CL_FPM_BOL_MODEL has no exception.

Method SET_SIDE_PANEL_LINK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ACTIVE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20110107
2	Importing	IV_TEXT	Call by reference	☐	Type reference (TYPE)	CLIKE			20110110

Method SET_SIDE_PANEL_LINK on class CL_FPM_BOL_MODEL has no exception.

Method SET_UP_PORT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_OBJECT_KEY	Call by reference	☑	Type reference (TYPE)	S_OBJECT_KEY			20100907
2	Importing	IV_PORT_DESCRIPTION	Call by reference	☑	Type reference (TYPE)	FPM_MODEL_PORT_DESCRIPTION		FPM Wire Model: Port Description	20100907
3	Importing	IV_PORT_IDENTIFIER	Call by reference	☐	Type reference (TYPE)	FPM_MODEL_PORT_IDENTIFIER	CV_PORT_IDENTIFIER	FPM Wire Model: Port Identifier	20090422
4	Importing	IV_PORT_TYPE	Call by reference	☐	Type reference (TYPE)	FPM_MODEL_PORT_TYPE		FPM Wire Model: Port Type	20090420

Method SET_UP_PORT on class CL_FPM_BOL_MODEL has no exception.

Method SET_UP_PORTS Signature

Method SET_UP_PORTS on class CL_FPM_BOL_MODEL has no parameter.
Method SET_UP_PORTS on class CL_FPM_BOL_MODEL has no exception.

Method START_UP Signature

Method START_UP on class CL_FPM_BOL_MODEL has no parameter.
Method START_UP on class CL_FPM_BOL_MODEL has no exception.

Method TAP_CONNECTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_INITIAL_DATA	Call by reference	☑	Type reference (TYPE)	FPM_BOL_INITIAL_DATA		Initial Data for Entity Creation/Derivation with Connector	20090420

Method TAP_CONNECTOR on class CL_FPM_BOL_MODEL has no exception.

Event Signatures

Event MESSAGES_CLAIMED Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	IO_FPM	Exporting	Value transfer	☑	Object reference (TYPE REF TO)	IF_FPM		Interface for accessing FPM functionality	20110413
2	IT_SHOW_MULTI	Exporting	Value transfer	☑	Type reference (TYPE)	CRMT_GENIL_MESSAGE_TAB		Message Table	20101006
3	IV_SEVERITY	Exporting	Value transfer	☐	Type reference (TYPE)	FPM_MESSAGE_SEVERITY	IF_FPM_MESSAGE_MANAGER=>GC_SEVERITY_ERROR	Severity of messages reported in FPM	20090420

History

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