SAP ABAP Class /BCV/CL_UIF_TAGGING (Auxiliary Class for PageBuilder Tagging)

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_TAGGING
Short Description	Auxiliary Class for PageBuilder Tagging
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	/BCV/UIF	BCV User Interface Layer
Created	20120410	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_TAGGING_MANAGER	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

Class /BCV/CL_UIF_TAGGING has no interface implemented.

Friends

Class /BCV/CL_UIF_TAGGING has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_ATTR_PREFIX	Constant	Public	☐	Type reference (TYPE)	STRING	'TAG_'	Prefix of Tag Context Attributes	20120412
2	GC_BCV_TAG_PREFIX	Constant	Public	☐	Type reference (TYPE)	STRING	'/BCV/:'	Prefix of BCV Tags	20120410
3	GC_TAG_CONTEXT_NAME	Constant	Public	☐	Type reference (TYPE)	STRING	'TAG_VALUES'	Name of Tag Context Node	20120410
4	GT_MEANING	Static Attribute	Private	☐	Type reference (TYPE)	/BCV/T_FND_MEANING		Table of all BCV Meanings	20120413
5	GV_BCV_LENGTH	Static Attribute	Private	☐	Type reference (TYPE)	/BCV/FND_INT4		Length of BCV Tag Prefix	20120411
6	GV_HASH_LENGTH	Static Attribute	Private	☐	Type reference (TYPE)	/BCV/FND_INT4		Length of Hash Key (in Bytes)	20120410

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CALCULATE_HASH_STRING	Static method	Private	Method	Calculate hash of string	20120410
2	CALCULATE_HASH_XSTRING	Static method	Private	Method	Calculate hash of xstring	20120410
3	CLASS_CONSTRUCTOR	Static method	Public	Constructor	Class Constructor	20120410
4	CREATE_TAG_CONTEXT	Static method	Public	Method	Create context that represents tag values	20120410
5	DESERIALIZE_TAG_VALUES	Static method	Public	Method	Deserialize xstring into tag values table	20120410
6	GET_MEANING	Static method	Private	Method	Get BCV Meaning of Tag	20120411
7	GET_NAME_VALUE_LIST	Static method	Private	Method	Provides all tags with values (ref to data)	20120412
8	GET_TAG_VALUES	Static method	Public	Method	Get current values of all existing tags	20120410
9	SERIALIZE_TAG_VALUES	Static method	Public	Method	Serialize tag values table into xstring	20120410
10	SET_TAG_VALUE	Static method	Public	Method	Set tag value	20120413

Events

Class /BCV/CL_UIF_TAGGING has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_S_TAG_CONTEXT	Public	See coding		Tag Context Node Structure Type	20120410	BEGIN OF ty_s_tag_context, tag_name TYPE wdy_tag_name, meaning TYPE /bcv/fnd_meaning, context_node TYPE REF TO if_wd_context_node, attr_name TYPE string, END OF ty_s_tag_context
2	TY_S_TAG_VALUE	Public	See coding		Tag/Value Structure Type	20120410	BEGIN OF ty_s_tag_value, tag_name TYPE wdy_tag_name, meaning TYPE /bcv/fnd_meaning, value_tab TYPE /bcv/t_fnd_string, END OF ty_s_tag_value
3	TY_T_TAG_CONTEXT	Public	See coding		Tag Context Node Table Type	20120410	ty_t_tag_context TYPE STANDARD TABLE OF ty_s_tag_context
4	TY_T_TAG_VALUE	Public	See coding		Tag/Value Table Type	20120410	ty_t_tag_value TYPE STANDARD TABLE OF ty_s_tag_value

Method Signatures

Method CALCULATE_HASH_STRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_STRING	Call by reference	☐	Type reference (TYPE)	STRING		String	20120410
2	Returning	RV_HASH	Value transfer	☐	Type reference (TYPE)	HASH160		Hash of string	20120410

Method CALCULATE_HASH_STRING on class /BCV/CL_UIF_TAGGING has no exception.

Method CALCULATE_HASH_XSTRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_XSTRING	Call by reference	☐	Type reference (TYPE)	XSTRING		Xstring	20120410
2	Returning	RV_HASH	Value transfer	☐	Type reference (TYPE)	HASH160X		Hash of Xstring	20120410

Method CALCULATE_HASH_XSTRING on class /BCV/CL_UIF_TAGGING has no exception.

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class /BCV/CL_UIF_TAGGING has no parameter.
Method CLASS_CONSTRUCTOR on class /BCV/CL_UIF_TAGGING has no exception.

Method CREATE_TAG_CONTEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_TAG_CONTEXT	Call by reference	☐	Type reference (TYPE)	TY_T_TAG_CONTEXT		Table of tag context nodes	20120410
2	Importing	IO_COMPONENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_COMPONENT		Component	20120411
3	Importing	IO_CONTEXT	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_CONTEXT_NODE		Controller Context	20120410
4	Importing	IT_TAG_VALUE	Call by reference	☐	Type reference (TYPE)	TY_T_TAG_VALUE		Table of tag values	20120410
5	Importing	IV_CONTEXT_NODE_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Name of Context Node for Tag Context	20120410

Method CREATE_TAG_CONTEXT on class /BCV/CL_UIF_TAGGING has no exception.

Method DESERIALIZE_TAG_VALUES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_TAG_VALUE	Call by reference	☐	Type reference (TYPE)	TY_T_TAG_VALUE		Table of tag values	20120410
2	Importing	IV_SERIALIZED	Call by reference	☐	Type reference (TYPE)	XSTRING		Serialized tag values	20120410

Method DESERIALIZE_TAG_VALUES on class /BCV/CL_UIF_TAGGING has no exception.

Method GET_MEANING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TAG_NAME	Call by reference	☐	Type reference (TYPE)	WDY_TAG_NAME		Tag Name	20120411
2	Returning	RV_MEANING	Value transfer	☐	Type reference (TYPE)	/BCV/FND_MEANING		BCV Meaning (initial if non-BCV tag)	20120411

Method GET_MEANING on class /BCV/CL_UIF_TAGGING has no exception.

Method GET_NAME_VALUE_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_NAME_VALUE	Value transfer	☐	Type reference (TYPE)	CL_WD_TAGGING_MANAGER=>TY_NAME_VALUE_TAB		Tag values table	20120412

Method GET_NAME_VALUE_LIST on class /BCV/CL_UIF_TAGGING has no exception.

Method GET_TAG_VALUES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_TAG_VALUE	Call by reference	☐	Type reference (TYPE)	TY_T_TAG_VALUE		Table of Current Tag Values	20120410
2	Importing	IV_BCV_ONLY	Call by reference	☐	Type reference (TYPE)	BOOLE_D	ABAP_FALSE	Only BCV Tags	20120410

Method GET_TAG_VALUES on class /BCV/CL_UIF_TAGGING has no exception.

Method SERIALIZE_TAG_VALUES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_SERIALIZED	Call by reference	☐	Type reference (TYPE)	XSTRING		Serialized tag values	20120410
2	Importing	IT_TAG_VALUE	Call by reference	☐	Type reference (TYPE)	TY_T_TAG_VALUE		Table of tag values	20120410
3	Importing	IV_COMPRESS	Call by reference	☐	Type reference (TYPE)	BOOLE_D	ABAP_FALSE	Compress serialization	20120410

Method SERIALIZE_TAG_VALUES on class /BCV/CL_UIF_TAGGING has no exception.

Method SET_TAG_VALUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_CONTEXT_NODE	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_CONTEXT_NODE		Context Node of Tag	20120413
2	Importing	IV_ATTR_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Context Attribute Name of Tag	20120413
3	Importing	IV_REPLACE	Call by reference	☐	Type reference (TYPE)	BOOLE_D	ABAP_TRUE	Replace Existing Value(s)	20120413
4	Importing	IV_VALUE	Call by reference	☐	Type reference (TYPE)	STRING		Tag Value	20120413

Method SET_TAG_VALUE on class /BCV/CL_UIF_TAGGING has no exception.

History

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