SAP ABAP Class CL_GUIBB_BOL_BASE_JOIN (Generic BOL Feeder Join View)

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_GUIBB_BOL_BASE	Generic BOL Feeder Base	20100504

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_GUIBB_BOL_COLLECTION	Generic BOL Feeder List	20100607
2	Inheritance (c INHERITING FROM c_ref)	CL_GUIBB_BOL_FORM	Generic BOL Feeder Form	20100505

Properties

Class	CL_GUIBB_BOL_BASE_JOIN
Short Description	Generic BOL Feeder Join View
Super Class	CL_GUIBB_BOL_BASE	Generic BOL Feeder Base
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	20100504	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)

Interfaces

Class CL_GUIBB_BOL_BASE_JOIN has no interface implemented.

Friends

Class CL_GUIBB_BOL_BASE_JOIN has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CV_PARAM_BOL_OBJ_MAP_TAB	Constant	Public	☐	Type reference (TYPE)	STRING	'BOL_OBJECT_MAP_TABLE'		20110518
2	CV_PARAM_JOIN	Constant	Public	☐	Type reference (TYPE)	STRING	'JOINED_OBJECTS'		20100716
3	CV_SP_GROUP_NULL	Constant	Protected	☐	Type reference (TYPE)	JOIN_ID	'0000'		20100505
4	MT_JOIN	Instance attribute	Protected	☐	Type reference (TYPE)	T_JOIN			20100505
5	MT_JOIN_ACTION	Instance attribute	Protected	☐	Type reference (TYPE)	T_JOIN_ACTION			20100721
6	MT_JOIN_ATTR	Instance attribute	Protected	☐	Type reference (TYPE)	T_JOIN_ATTR			20100505
7	MT_JOIN_EDIT	Instance attribute	Protected	☐	Type reference (TYPE)	T_JOIN_EDIT			20100923
8	MT_JOIN_RELATION_FILTER	Instance attribute	Private	☐	Type reference (TYPE)	T_JOIN_RELATION_FILTER			20120302
9	MT_JOIN_USAGE	Instance attribute	Protected	☐	Type reference (TYPE)	T_JOIN_USAGE			20100927
10	MV_JOIN_COUNT	Instance attribute	Protected	☐	See coding		'0000'		20100722

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_JOIN_METHOD_ACTIONS	Instance method	Protected	Method	Adds the actions arising from a from a join object method	20100727
2	CREATE_JOIN_CHILDREN	Instance method	Protected	Method	Recursively creates the child entities for a join	20100506
3	EXTEND_BY_JOINED_OBJECTS	Instance method	Protected	Method	Extend RTTI and metadata by join object attributes	20100505
4	GET_FIELD_PROPS_FOR_USAGE	Instance method	Protected	Method	Retrieves the field properties for the field usage	20100927
5	GET_JOINED_ENTITY	Instance method	Protected	Method	Returns the enitity related by a join	20100506
6	GET_JOIN_BOL_ATTR	Instance method	Protected	Method	Retrieves the BOL attribute for a (mapped) object attribute	20110520
7	GET_JOIN_CHILDREN_DATA	Instance method	Protected	Method	Retrieve attrubtes for join child entities	20100505
8	GET_JOIN_ENTITY_DATA	Instance method	Protected	Method	Retrieve data for joined entity	20100923
9	GET_JOIN_INITIAL_DATA	Instance method	Protected	Method	Returns initial data for join relations	20120301
10	GET_JOIN_MAPPER	Instance method	Protected	Method	Returns the mapper instance for a join ID	20110520
11	GET_JOIN_MESSAGES	Instance method	Protected	Method	Retrieve the messages affiliated to join enities	20100507
12	GET_JOIN_METHOD_ACTIONS	Instance method	Protected	Method	Get the actions from join object methods	20100721
13	GET_JOIN_OUPORT_DATA	Instance method	Protected	Method	Returns a collection for a join outport	20100907
14	GET_JOIN_PATH	Instance method	Protected	Method	Returns the relation path for a join	20100721
15	GET_JOIN_RELATION_FILTER	Instance method	Protected	Method	Returns relation filter (buffered) for join	20120302
16	IS_JOIN_ENABLED	Instance method	Protected	Method	Is this class enabled for joining BOL objects	20100505
17	SET_UP_JOIN_PORTS	Instance method	Protected	Method	Defines the ports arising from joins	20100907
18	TRANSFER_JOINS	Instance method	Protected	Method	Transfers the join definition into internal metadata	20100722

Events

Class CL_GUIBB_BOL_BASE_JOIN has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	JOIN_ID	Protected	Type reference (TYPE)	SP_GROUP		20100505
2	S_JOIN	Protected	See coding			20100505	BEGIN OF s_join, id TYPE join_id, parent_id TYPE join_id, component_name TYPE crmt_component_name, object_name TYPE crmt_ext_obj_name, relation_name TYPE crmt_relation_name, suffix TYPE dd_suffix, include_name TYPE string, dark TYPE fpm_bol_dark_join, dark_tail TYPE abap_bool, exposed_port_id TYPE fpm_model_port_identifier, END OF s_join
3	S_JOIN_ACTION	Protected	See coding			20100721	BEGIN OF s_join_action, event_id TYPE fpm_event_id, join_id TYPE join_id, method TYPE crmt_obj_method_name, has_param TYPE abap_bool, END OF s_join_action
4	S_JOIN_ATTR	Protected	See coding			20100505	BEGIN OF s_join_attr, name TYPE name_komp, join_id TYPE join_id, bol_attr_name TYPE name_komp, END OF s_join_attr
5	S_JOIN_EDIT	Protected	See coding			20100923	BEGIN OF s_join_edit, join_id TYPE join_id, fields TYPE crmt_attr_name_tab, END OF s_join_edit
6	S_JOIN_RELATION_FILTER	Private	See coding			20120302	BEGIN OF s_join_relation_filter, join_id TYPE join_id, filter TYPE REF TO cl_crm_bol_relation_filter, END OF s_join_relation_filter
7	S_JOIN_USAGE	Protected	See coding			20100927	BEGIN OF s_join_usage, join_id TYPE join_id, attributes TYPE crmt_attr_name_tab, entity TYPE REF TO cl_crm_bol_entity, change_allowed TYPE abap_bool, field_props TYPE cl_crm_bol_entity=>gtype_attr_props_tab, END OF s_join_usage
8	T_JOIN	Protected	See coding			20100505	t_join TYPE SORTED TABLE OF s_join WITH UNIQUE KEY id WITH NON-UNIQUE SORTED KEY parent COMPONENTS parent_id WITH NON-UNIQUE SORTED KEY port_id COMPONENTS exposed_port_id WITH NON-UNIQUE SORTED KEY object COMPONENTS object_name component_name
9	T_JOIN_ACTION	Protected	See coding			20100721	t_join_action TYPE SORTED TABLE OF s_join_action WITH UNIQUE KEY event_id WITH NON-UNIQUE SORTED KEY join COMPONENTS join_id
10	T_JOIN_ATTR	Protected	See coding			20100505	t_join_attr TYPE SORTED TABLE OF s_join_attr WITH UNIQUE KEY name WITH UNIQUE SORTED KEY join_attr COMPONENTS bol_attr_name join_id
11	T_JOIN_EDIT	Protected	See coding			20100923	t_join_edit TYPE SORTED TABLE OF s_join_edit WITH UNIQUE KEY join_id
12	T_JOIN_RELATION_FILTER	Private	See coding			20120302	t_join_relation_filter TYPE SORTED TABLE OF s_join_relation_filter WITH UNIQUE KEY join_id
13	T_JOIN_USAGE	Protected	See coding			20100927	t_join_usage TYPE SORTED TABLE OF s_join_usage WITH UNIQUE KEY join_id

Method Signatures

Method ADD_JOIN_METHOD_ACTIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_JOIN_ID	Call by reference	☐	Type reference (TYPE)	JOIN_ID			20100727
2	Importing	IV_METHOD_NAME	Call by reference	☐	Type reference (TYPE)	CRMT_OBJ_METHOD_NAME		Name of Business Object Method	20100727
3	Importing	IV_PARAM_STRUCT	Call by reference	☐	Type reference (TYPE)	STRUKNAME		Name of a structure	20100727

Method ADD_JOIN_METHOD_ACTIONS on class CL_GUIBB_BOL_BASE_JOIN has no exception.

Method CREATE_JOIN_CHILDREN 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	20100506
2	Importing	IS_CREATE_CTRL	Call by reference	☑	Type reference (TYPE)	FPM_BOL_ENTITY_CREATE_CONTROL		Create Parameter	20100906
3	Importing	IV_JOIN_ID	Call by reference	☑	Type reference (TYPE)	JOIN_ID			20100506
4	Importing	IV_WITH_TEMPLATE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20111006

Method CREATE_JOIN_CHILDREN on class CL_GUIBB_BOL_BASE_JOIN has no exception.

Method EXTEND_BY_JOINED_OBJECTS Signature

Method EXTEND_BY_JOINED_OBJECTS on class CL_GUIBB_BOL_BASE_JOIN has no parameter.
Method EXTEND_BY_JOINED_OBJECTS on class CL_GUIBB_BOL_BASE_JOIN has no exception.

Method GET_FIELD_PROPS_FOR_USAGE 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	20100927
2	Importing	IT_FIELD_USAGE	Call by reference	☐	Type reference (TYPE)	FPMGB_T_FIELDUSAGE		Field Usage	20100927

Method GET_FIELD_PROPS_FOR_USAGE on class CL_GUIBB_BOL_BASE_JOIN has no exception.

Method GET_JOINED_ENTITY 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	20100506
2	Importing	IV_JOIN_ID	Call by reference	☐	Type reference (TYPE)	JOIN_ID			20100506
3	Returning	RO_ENTITY	Value transfer	☐	Object reference (TYPE REF TO)	CL_CRM_BOL_ENTITY		Entity	20100506

Method GET_JOINED_ENTITY on class CL_GUIBB_BOL_BASE_JOIN has no exception.

Method GET_JOIN_BOL_ATTR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ATTRIBUTE_NAME	Call by reference	☐	Type reference (TYPE)	NAME_KOMP		Component name	20110520
2	Importing	IV_JOIN_ID	Call by reference	☐	Type reference (TYPE)	JOIN_ID			20110520
3	Returning	RV_ATTRIBUTE_NAME	Value transfer	☐	Type reference (TYPE)	NAME_KOMP		Component name	20110520

Method GET_JOIN_BOL_ATTR on class CL_GUIBB_BOL_BASE_JOIN has no exception.

Method GET_JOIN_CHILDREN_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CS_DATA	Call by reference	☐	Type reference (TYPE)	DATA			20100505
2	Importing	IO_ENTITY	Call by reference	☐	Object reference (TYPE REF TO)	CL_CRM_BOL_ENTITY		Entity	20100505
3	Importing	IV_JOIN_ID	Call by reference	☑	Type reference (TYPE)	JOIN_ID			20100505

Method GET_JOIN_CHILDREN_DATA on class CL_GUIBB_BOL_BASE_JOIN has no exception.

Method GET_JOIN_ENTITY_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CS_DATA	Call by reference	☐	Type reference (TYPE)	DATA			20100923
2	Importing	IO_ENTITY	Call by reference	☐	Object reference (TYPE REF TO)	CL_CRM_BOL_ENTITY		Entity	20100923
3	Importing	IS_JOIN	Call by reference	☐	Type reference (TYPE)	S_JOIN			20100923

Method GET_JOIN_ENTITY_DATA on class CL_GUIBB_BOL_BASE_JOIN has no exception.

Method GET_JOIN_INITIAL_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CHILD_OBJECT	Call by reference	☐	Type reference (TYPE)	CRMT_EXT_OBJ_NAME		External Name of Object	20120301
2	Importing	IV_FOR_CREATE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20120301
3	Importing	IV_JOIN_ID	Call by reference	☐	Type reference (TYPE)	JOIN_ID			20120301
4	Importing	IV_RELATION	Call by reference	☐	Type reference (TYPE)	CRMT_RELATION_NAME		Relation Name	20120301
5	Returning	RS_INITIAL_DATA	Value transfer	☐	Type reference (TYPE)	FPM_BOL_INITIAL_DATA			20120301

Method GET_JOIN_INITIAL_DATA on class CL_GUIBB_BOL_BASE_JOIN has no exception.

Method GET_JOIN_MAPPER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_JOIN_ID	Call by reference	☐	Type reference (TYPE)	JOIN_ID			20110520
2	Returning	RO_OBJECT_MAPPER	Value transfer	☐	Object reference (TYPE REF TO)	IF_FPM_BOL_OBJECT_UI_MAPPER		Mapper interface for BOL objects and UI structure	20110520

Method GET_JOIN_MAPPER on class CL_GUIBB_BOL_BASE_JOIN has no exception.

Method GET_JOIN_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			20100507
2	Importing	IV_INDEX	Call by reference	☐	Type reference (TYPE)	SYINDEX	0	Loop Index	20100507
3	Importing	IV_JOIN_ID	Call by reference	☐	Type reference (TYPE)	JOIN_ID			20100507
4	Returning	RT_MESSAGES	Value transfer	☐	Type reference (TYPE)	FPMGB_T_MESSAGES			20100507

Method GET_JOIN_MESSAGES on class CL_GUIBB_BOL_BASE_JOIN has no exception.

Method GET_JOIN_METHOD_ACTIONS Signature

Method GET_JOIN_METHOD_ACTIONS on class CL_GUIBB_BOL_BASE_JOIN has no parameter.
Method GET_JOIN_METHOD_ACTIONS on class CL_GUIBB_BOL_BASE_JOIN has no exception.

Method GET_JOIN_OUPORT_DATA 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	20100907
2	Importing	IV_PORT_TYPE	Call by reference	☐	Type reference (TYPE)	FPM_MODEL_PORT_TYPE		FPM Wire Model: Port Type	20100907
3	Returning	RO_COLLECTION	Value transfer	☐	Object reference (TYPE REF TO)	IF_BOL_ENTITY_COL		Entities Collection Interface	20100907

Method GET_JOIN_OUPORT_DATA on class CL_GUIBB_BOL_BASE_JOIN has no exception.

Method GET_JOIN_PATH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_JOIN_ID	Call by reference	☐	Type reference (TYPE)	JOIN_ID			20100721
2	Returning	RV_PATH	Value transfer	☐	Type reference (TYPE)	STRING			20100721

Method GET_JOIN_PATH on class CL_GUIBB_BOL_BASE_JOIN has no exception.

Method GET_JOIN_RELATION_FILTER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_ATTRIBUTES	Call by reference	☐	Object reference (TYPE REF TO)	DATA			20120302
2	Importing	IV_JOIN_ID	Call by reference	☐	Type reference (TYPE)	JOIN_ID			20120302
3	Importing	IV_RELATION_NAME	Call by reference	☐	Type reference (TYPE)	CRMT_RELATION_NAME		Relation Name	20120302
4	Returning	RO_FILTER	Value transfer	☐	Object reference (TYPE REF TO)	CL_CRM_BOL_RELATION_FILTER		Filter Object for a Relation	20120302

Method GET_JOIN_RELATION_FILTER on class CL_GUIBB_BOL_BASE_JOIN has no exception.

Method IS_JOIN_ENABLED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_ENABLED	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20100505

Method IS_JOIN_ENABLED on class CL_GUIBB_BOL_BASE_JOIN has no exception.

Method SET_UP_JOIN_PORTS Signature

Method SET_UP_JOIN_PORTS on class CL_GUIBB_BOL_BASE_JOIN has no parameter.
Method SET_UP_JOIN_PORTS on class CL_GUIBB_BOL_BASE_JOIN has no exception.

Method TRANSFER_JOINS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_DARK_TAIL	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20130107
2	Importing	IT_JOIN	Call by reference	☐	Type reference (TYPE)	FPM_BOL_T_JOIN		FPM BOL Join Definition	20100722
3	Importing	IV_PARENT_ID	Call by reference	☑	Type reference (TYPE)	JOIN_ID			20100722
4	Importing	IV_PARENT_KEY	Call by reference	☑	Type reference (TYPE)	FPM_BOL_S_JOIN-PARENT_KEY		Parent Join ID	20100722

Method TRANSFER_JOINS on class CL_GUIBB_BOL_BASE_JOIN has no exception.

History

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