SAP ABAP Interface IF_TFW_RATING (Rating Interface)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-TFW (Application Component) Tagging Framework
     ⤷ STFW_CORE (Package) Tagging Framework Core

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	CL_TFW_RATING	Object Rating Implementation	20130412

Properties

Interface	IF_TFW_RATING
Short Description	Rating Interface

General Data

Package	STFW_CORE	Tagging Framework Core
Created	20130412	SAP
Last changed	20140121	SAP
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	IF_TFW_RATING	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_TFW_METADATA	☐	☐	Metadata Interface	20130412

Friends

Interface IF_TFW_RATING has no friend.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_DEFAULT_FEATURE_KEY	Constant	Public	☐	Type reference (TYPE)	TFW_FEAT_KEY	'OVRL'	Feature Key	20130418
2	GC_DEFAULT_FEATURE_NAME	Constant	Public	☐	Type reference (TYPE)	TFW_FEAT_NAME	'OVERALL'	Feature Name	20130417

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_RATINGS	Instance method	Public	Method	Assign a rating to an Object by a User	20130416
2	GET_RATINGS	Instance method	Public	Method	Get average rating for a object	20130416
3	GET_RATING_STATS_FOR_FEATURE	Instance method	Public	Method	Get ratings statistics for a given feature	20130418

Events

Interface IF_TFW_RATING has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	S_FEAT_LIST	Public	See coding		List of features	20130620	BEGIN OF s_feat_list, feat_key TYPE tfw_feat_key, feat_name TYPE tfw_feat_name, langu TYPE sylangu, feat_desc TYPE tfw_feat_descr, END OF s_feat_list
2	S_RATING	Public	See coding		Rating info	20130416	BEGIN OF s_rating, feat_key TYPE tfw_feat_key, rating TYPE tfw_rating, comment TYPE tfw_cmnt_txt, END OF s_rating
3	S_RATING_AGGR	Public	See coding		Average rating for each feature	20130418	BEGIN OF s_rating_aggr, feat_key TYPE tfw_feat_key, avg_rating TYPE tfw_rating_avg, no_of_rating TYPE int4, END OF s_rating_aggr
4	S_RATING_DB	Public	See coding		Rating db type	20130418	BEGIN OF s_rating_db, object_id TYPE if_tfw_types=>object_id, object_type_id TYPE if_tfw_types=>object_type_id, seqnr TYPE n LENGTH 6, featurekey TYPE tfw_feat_key, rating TYPE tfw_rating, comment_txt TYPE tfw_cmnt_txt. TYPES: created_by TYPE tfw_unam, created_on TYPE tfw_tmstmp, simplekey TYPE abap_bool. TYPES: END OF s_rating_db
5	S_RATING_DETAIL	Public	See coding		Rating detail	20130418	BEGIN OF s_rating_detail, feat_key TYPE tfw_feat_key, rating TYPE tfw_rating, comment TYPE tfw_cmnt_txt, created_by TYPE tfw_unam, created_on TYPE tfw_tmstmp, END OF s_rating_detail
6	S_RATING_STAT	Public	See coding		Rating statistics	20130418	BEGIN OF s_rating_stat, rating TYPE tfw_rating, no_of_rating TYPE int4, END OF s_rating_stat
7	TS_RATING	Public	See coding		Table type for rating info	20130418	ts_rating TYPE SORTED TABLE OF s_rating WITH UNIQUE KEY feat_key
8	TS_RATING_AGGR	Public	See coding		Table type for average rating for each feature	20130418	ts_rating_aggr TYPE SORTED TABLE OF s_rating_aggr WITH UNIQUE KEY feat_key
9	TS_RATING_DB	Public	See coding		Table type for rating db	20130418	ts_rating_db TYPE SORTED TABLE OF s_rating_db WITH UNIQUE KEY object_id object_type_id seqnr
10	TS_RATING_STAT	Public	See coding		Table type for rating statistics	20130418	ts_rating_stat TYPE SORTED TABLE OF s_rating_stat WITH UNIQUE KEY rating
11	T_FEAT_LIST	Public	See coding		Table type for list of features	20130620	t_feat_list TYPE STANDARD TABLE OF s_feat_list WITH NON-UNIQUE DEFAULT KEY
12	T_RATING_DETAIL	Public	See coding		Table type for Rating detail	20130524	t_rating_detail TYPE STANDARD TABLE OF s_rating_detail WITH NON-UNIQUE DEFAULT KEY

Method Signatures

Method ADD_RATINGS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_RATINGS	Call by reference	☑	Type reference (TYPE)	IF_TFW_RATING=>TS_RATING		Table of Ratings	20130416

#	Exception	Resumable	Description	Created on
1	CX_TFW_RUNTIME_ERROR	☐	TFW: Runtime Exception Class	20130419

Method GET_RATINGS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_RATING_AGGR	Call by reference	☐	Type reference (TYPE)	IF_TFW_RATING=>TS_RATING_AGGR		Table of Aggregate Ratings per feature	20130418
2	Exporting	ET_RATING_DETAIL	Call by reference	☐	Type reference (TYPE)	IF_TFW_RATING=>T_RATING_DETAIL		Details of all ratings for the object	20130418

#	Exception	Resumable	Description	Created on
1	CX_TFW_RUNTIME_ERROR	☐	TFW: Runtime Exception Class	20130613

Method GET_RATING_STATS_FOR_FEATURE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FEAT_KEY	Call by reference	☐	Type reference (TYPE)	TFW_FEAT_KEY		TFW: Feature Name	20130627
2	Returning	RT_RATING_STATS	Value transfer	☐	Type reference (TYPE)	IF_TFW_RATING=>TS_RATING_STAT		TFW: Ratings breakdown per feature	20130418

#	Exception	Resumable	Description	Created on
1	CX_TFW_RUNTIME_ERROR	☐	TFW: Runtime Exception Class	20130613

History

Last changed by/on	SAP	20140121
SAP Release Created in	740