SAP ABAP Class /BCV/CL_UIF_BREADCRUMB (Breadcrumbs)

Hierarchy

☛ SAP_BS_FND (Software Component) SAP Business Suite Foundation
   ⤷ CA-EPT-BCV (Application Component) Business Context Viewer
     ⤷ /BCV/UIF (Package) BCV User Interface Layer

Properties

Class	/BCV/CL_UIF_BREADCRUMB
Short Description	Breadcrumbs
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status
Category	0
Package	/BCV/UIF	BCV User Interface Layer
Created	20090826	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 /BCV/CL_UIF_BREADCRUMB has no interface implemented.

Friends

Class /BCV/CL_UIF_BREADCRUMB has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GO_BREADCRUMB_PARENT	Instance attribute	Private	☐	Object reference (TYPE REF TO)	/BCV/CL_UIF_BREADCRUMB		Parent breadcrumb	20090903
2	GO_CONTEXT	Instance attribute	Private	☐	Object reference (TYPE REF TO)	/BCV/CL_UIF_CONTEXT		Context for query view processing	20090903
3	GT_BREADCRUMB_CHILD	Instance attribute	Private	☐	Type reference (TYPE)	/BCV/T_UIF_BREADCRUMB		Child breadcrumbs	20090828
4	GV_MAX_NODE_ID	Static Attribute	Private	☐	Type reference (TYPE)	/BCV/FND_NODE_ID		Node ID	20090826
5	GV_NODE_ID	Instance attribute	Private	☐	Type reference (TYPE)	/BCV/FND_NODE_ID		Node ID	20090826

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CLEAR	Instance method	Private	Method	Clear the data of an breadcrumb	20090826
2	CONSTRUCTOR	Instance method	Private	Constructor	Constructor	20090826
3	CREATE_BREADCRUMB_CHILD	Instance method	Public	Method	Creates a child breadcrumb instance	20090826
4	CREATE_BREADCRUMB_ROOT	Static method	Public	Method	Creates the root breadcrumb instance	20090831
5	DELETE_BREADCRUMB	Instance method	Public	Method	Deletes a breadcrumb and all of its children	20090826
6	DELETE_BREADCRUMB_CHILD	Instance method	Public	Method	Deletes all children of this breadcrumb	20090826
7	GET_BREADCRUMB_BY_NODE_ID	Instance method	Public	Method	Get related breadcrumb by node ID	20090907
8	GET_BREADCRUMB_CHILD	Instance method	Public	Method	Get all children of this breadcrumb	20090826
9	GET_BREADCRUMB_LIST	Instance method	Public	Method	Get breadcrumb list chronologically sorted (by node ID)	20090828
10	GET_BREADCRUMB_PARENT	Instance method	Public	Method	Returns the parent breadcrumb instance	20090826
11	GET_BREADCRUMB_ROOT	Instance method	Private	Method	Get root breadcrumb	20090828
12	GET_BREADCRUMB_SUCCESSOR	Instance method	Private	Method	Get breadcrumb successors, (children, their children, ....)	20090831
13	GET_CONTEXT	Instance method	Public	Method	Get breadcrumb context	20090826
14	GET_MEANING_VALUE	Instance method	Public	Method	Get meaning values of breadcrumb and parents	20090828
15	GET_NODE_ID	Instance method	Public	Method	Returns the node ID of the breadcrumb	20090826
16	IS_PREDECESSOR	Instance method	Public	Method	Check if this is a predecessor of the given breadcrumb	20091211
17	SET_CONTEXT	Instance method	Public	Method	Set breadcrumb context	20090826

Events

Class /BCV/CL_UIF_BREADCRUMB has no event.

Types

Class /BCV/CL_UIF_BREADCRUMB has no local type.

Method Signatures

Method CLEAR Signature

Method CLEAR on class /BCV/CL_UIF_BREADCRUMB has no parameter.
Method CLEAR on class /BCV/CL_UIF_BREADCRUMB has no exception.

Method CONSTRUCTOR Signature

Method CONSTRUCTOR on class /BCV/CL_UIF_BREADCRUMB has no parameter.
Method CONSTRUCTOR on class /BCV/CL_UIF_BREADCRUMB has no exception.

Method CREATE_BREADCRUMB_CHILD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_BREADCRUMB	Value transfer	☐	Object reference (TYPE REF TO)	/BCV/CL_UIF_BREADCRUMB		Breadcrumbs	20090903

Method CREATE_BREADCRUMB_CHILD on class /BCV/CL_UIF_BREADCRUMB has no exception.

Method CREATE_BREADCRUMB_ROOT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_BREADCRUMB	Value transfer	☐	Object reference (TYPE REF TO)	/BCV/CL_UIF_BREADCRUMB		Breadcrumbs	20090903

Method CREATE_BREADCRUMB_ROOT on class /BCV/CL_UIF_BREADCRUMB has no exception.

Method DELETE_BREADCRUMB Signature

Method DELETE_BREADCRUMB on class /BCV/CL_UIF_BREADCRUMB has no parameter.
Method DELETE_BREADCRUMB on class /BCV/CL_UIF_BREADCRUMB has no exception.

Method DELETE_BREADCRUMB_CHILD Signature

Method DELETE_BREADCRUMB_CHILD on class /BCV/CL_UIF_BREADCRUMB has no parameter.
Method DELETE_BREADCRUMB_CHILD on class /BCV/CL_UIF_BREADCRUMB has no exception.

Method GET_BREADCRUMB_BY_NODE_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_NODE_ID	Call by reference	☐	Type reference (TYPE)	/BCV/FND_NODE_ID		Node ID	20090907
2	Returning	RO_BREADCRUMB	Value transfer	☐	Object reference (TYPE REF TO)	/BCV/CL_UIF_BREADCRUMB		Breadcrumbs	20090907

Method GET_BREADCRUMB_BY_NODE_ID on class /BCV/CL_UIF_BREADCRUMB has no exception.

Method GET_BREADCRUMB_CHILD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_BREADCRUMB	Value transfer	☐	Type reference (TYPE)	/BCV/T_UIF_BREADCRUMB		Breadcrumb instances	20090826

Method GET_BREADCRUMB_CHILD on class /BCV/CL_UIF_BREADCRUMB has no exception.

Method GET_BREADCRUMB_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_BREADCRUMB	Value transfer	☐	Type reference (TYPE)	/BCV/T_UIF_BREADCRUMB		Breadcrumb instances	20090828

Method GET_BREADCRUMB_LIST on class /BCV/CL_UIF_BREADCRUMB has no exception.

Method GET_BREADCRUMB_PARENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_INSTANCE	Value transfer	☐	Object reference (TYPE REF TO)	/BCV/CL_UIF_BREADCRUMB		Breadcrumbs	20090903

Method GET_BREADCRUMB_PARENT on class /BCV/CL_UIF_BREADCRUMB has no exception.

Method GET_BREADCRUMB_ROOT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_BREADCRUMB	Value transfer	☐	Object reference (TYPE REF TO)	/BCV/CL_UIF_BREADCRUMB		Breadcrumbs	20090903

Method GET_BREADCRUMB_ROOT on class /BCV/CL_UIF_BREADCRUMB has no exception.

Method GET_BREADCRUMB_SUCCESSOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_BREADCRUMB	Value transfer	☐	Type reference (TYPE)	/BCV/T_UIF_BREADCRUMB		Breadcrumb instances	20090831

Method GET_BREADCRUMB_SUCCESSOR on class /BCV/CL_UIF_BREADCRUMB has no exception.

Method GET_CONTEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_CONTEXT	Value transfer	☐	Object reference (TYPE REF TO)	/BCV/CL_UIF_CONTEXT		Context for breadcrumb	20090903

Method GET_CONTEXT on class /BCV/CL_UIF_BREADCRUMB has no exception.

Method GET_MEANING_VALUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_MEANING	Call by reference	☐	Type reference (TYPE)	/BCV/T_UIF_MEANING		Meanings	20090828
2	Returning	RT_MEANING_VALUE	Value transfer	☐	Type reference (TYPE)	/BCV/T_UIF_VARIABLES_UI		Meaning values	20090828

Method GET_MEANING_VALUE on class /BCV/CL_UIF_BREADCRUMB has no exception.

Method GET_NODE_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_NODE_ID	Value transfer	☐	Type reference (TYPE)	/BCV/FND_NODE_ID		Node ID	20090826

Method GET_NODE_ID on class /BCV/CL_UIF_BREADCRUMB has no exception.

Method IS_PREDECESSOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_BREADCRUMB	Call by reference	☐	Object reference (TYPE REF TO)	/BCV/CL_UIF_BREADCRUMB		Breadcrumbs	20091211
2	Importing	IV_STRICT	Call by reference	☐	Type reference (TYPE)	BOOLE_D	ABAP_FALSE	Can a breadcrumb be a successor of itself?	20091211
3	Returning	RV_PREDECESSOR	Value transfer	☐	Type reference (TYPE)	BOOLE_D		Predecessor = 'X' or no predecessor = space	20091211

Method IS_PREDECESSOR on class /BCV/CL_UIF_BREADCRUMB has no exception.

Method SET_CONTEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_CONTEXT	Call by reference	☐	Object reference (TYPE REF TO)	/BCV/CL_UIF_CONTEXT		Context for breadcrumb	20090903

Method SET_CONTEXT on class /BCV/CL_UIF_BREADCRUMB has no exception.

History

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