SAP ABAP Interface IF_TFW_FACADE (Facade API's)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-TFW (Application Component) Tagging Framework
     ⤷ STFW_FACADE (Package) Tagging Framework Facade API's

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	CL_TFW_FACADE	Facade API for Tagging/Commenting/Rating	20130412

Properties

Interface	IF_TFW_FACADE
Short Description	Facade API's

General Data

Package	STFW_FACADE	Tagging Framework Facade API's
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_COMMENT	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
3	IF_TFW_RATING	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
4	IF_TFW_TAG	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
5	IF_TFW_TYPES	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

Interface IF_TFW_FACADE has no interface.

Friends

Interface IF_TFW_FACADE has no friend.

Attributes

Interface IF_TFW_FACADE has no attribute.

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_COMMENT	Instance method	Public	Method	Add a single comment	20130417
2	ADD_RATING	Instance method	Public	Method	Add Ratings	20130523
3	ADD_TAGS	Instance method	Public	Method	Add Tags	20130416
4	DELETE_COMMENT	Instance method	Public	Method	Delete single comment/based on user/all	20130417
5	DELETE_TAGS	Instance method	Public	Method	Delete Tags	20130416
6	GET_COMMENTS	Instance method	Public	Method	Get All Comments	20130412
7	GET_FACADE_INSTANCE	Static method	Public	Method	Return a singleton instance of the buffer	20130605
8	GET_RATINGS	Instance method	Public	Method	Get Ratings of the object	20130523
9	GET_RATING_STATS_FOR_FEATURE	Instance method	Public	Method	Get rating statistics for a given feature	20130523
10	GET_TAGS	Instance method	Public	Method	Get All Tags	20130412
11	RESET_BUFFER	Instance method	Public	Method	Reset the buffer to freshly load data from DB	20130606
12	UPDATE_COMMENT	Instance method	Public	Method	Update single comment	20130417

Events

Interface IF_TFW_FACADE has no event.

Types

Interface IF_TFW_FACADE has no local type.

Method Signatures

Method ADD_COMMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_THREAD_ID	Call by reference	☐	Type reference (TYPE)	TFW_THREAD_ID		TFW: Comment Thread ID	20130513
2	Importing	IT_KEY_VALUE	Call by reference	☐	Type reference (TYPE)	IF_TFW_TYPES=>TS_OBJ_KEY_VAL		Table Type for Object Key-Value pair	20130417
3	Importing	IV_COMMENT_TEXT	Call by reference	☐	Type reference (TYPE)	TFW_CMNT_TXT		Comment Text	20130417
4	Importing	IV_OBJECT_TYPE_ID	Call by reference	☐	Type reference (TYPE)	IF_TFW_TYPES=>OBJECT_TYPE_ID		TFW: Object Type Identifier	20130417
5	Importing	IV_PARENT_COMMENT_ID	Call by reference	☑	Type reference (TYPE)	TFW_THREAD_ID		ID of parent comment, if the new comment is a child	20130417
6	Importing	IV_WRITE_THROUGH	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Save the comments to the DB	20130417

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

Method ADD_RATING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_KEY_VALUE	Call by reference	☐	Type reference (TYPE)	IF_TFW_TYPES=>TS_OBJ_KEY_VAL		Table Type for Object Key-Value pair	20130523
2	Importing	IV_COMMENT	Call by reference	☐	Type reference (TYPE)	TFW_CMNT_TXT		TFW: Comment Text	20130523
3	Importing	IV_FEAT_KEY	Call by reference	☐	Type reference (TYPE)	TFW_FEAT_KEY		TFW: Feature Key	20130627
4	Importing	IV_OBJECT_TYPE_ID	Call by reference	☐	Type reference (TYPE)	IF_TFW_TYPES=>OBJECT_TYPE_ID		TFW: Object Type Identifier	20130523
5	Importing	IV_RATING	Call by reference	☐	Type reference (TYPE)	TFW_RATING		Rating	20130523
6	Importing	IV_WRITE_THROUGH	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Save the rating to the DB	20130523

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

Method ADD_TAGS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_KEY_VALUE	Call by reference	☐	Type reference (TYPE)	IF_TFW_TYPES=>TS_OBJ_KEY_VAL		Table Type for Object Key-Value pair	20130416
2	Importing	IT_TAG	Call by reference	☐	Type reference (TYPE)	IF_TFW_TAG=>T_TAG		List of tags	20130416
3	Importing	IV_OBJECT_TYPE_ID	Call by reference	☐	Type reference (TYPE)	IF_TFW_TYPES=>OBJECT_TYPE_ID		TFW: Object Type Identifier	20130416
4	Importing	IV_WRITE_THROUGH	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Save the tag to the DB	20130416

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

Method DELETE_COMMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_COMMENT	Call by reference	☑	Type reference (TYPE)	IF_TFW_COMMENT=>S_COMMENT		Comment to be deleted;all children comments are also deleted	20130417
2	Importing	IT_KEY_VALUE	Call by reference	☐	Type reference (TYPE)	IF_TFW_TYPES=>TS_OBJ_KEY_VAL		Table Type for Object Key-Value pair	20130417
3	Importing	IV_DELETE_ALL	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	'X': Delete all comments	20130417
4	Importing	IV_DELETE_FOR_USER	Call by reference	☑	Type reference (TYPE)	TFW_UNAM		Delete all tags for user	20130417
5	Importing	IV_OBJECT_TYPE_ID	Call by reference	☐	Type reference (TYPE)	IF_TFW_TYPES=>OBJECT_TYPE_ID		TFW: Object Type Identifier	20130417
6	Importing	IV_WRITE_THROUGH	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	'X': Directly update db	20130417

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

Method DELETE_TAGS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_KEY_VALUE	Call by reference	☐	Type reference (TYPE)	IF_TFW_TYPES=>TS_OBJ_KEY_VAL		Table Type for Object Key-Value pair	20130416
2	Importing	IT_TAG	Call by reference	☑	Type reference (TYPE)	IF_TFW_TAG=>T_TAG		List of tags to be deleted	20130416
3	Importing	IV_DELETE_ALL	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	'X': Delete all tags	20130416
4	Importing	IV_OBJECT_TYPE_ID	Call by reference	☐	Type reference (TYPE)	IF_TFW_TYPES=>OBJECT_TYPE_ID		TFW: Object Type Identifier	20130416
5	Importing	IV_WRITE_THROUGH	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	'X': Directly update db	20130416

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

Method GET_COMMENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_KEY_VALUE	Call by reference	☐	Type reference (TYPE)	IF_TFW_TYPES=>TS_OBJ_KEY_VAL		Table Type for Object Key-Value pair	20130416
2	Importing	IV_OBJECT_TYPE_ID	Call by reference	☐	Type reference (TYPE)	IF_TFW_TYPES=>OBJECT_TYPE_ID		TFW: Object Type Identifier	20130416
3	Returning	RT_COMMENT	Value transfer	☐	Type reference (TYPE)	IF_TFW_COMMENT=>TS_COMMENT		List of comments	20130416

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

Method GET_FACADE_INSTANCE 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)	IF_TFW_FACADE			20130605

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

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	20130523
2	Exporting	ET_RATING_DETAIL	Call by reference	☐	Type reference (TYPE)	IF_TFW_RATING=>T_RATING_DETAIL		Details of all ratings for the object	20130523
3	Importing	IT_KEY_VALUE	Call by reference	☐	Type reference (TYPE)	IF_TFW_TYPES=>TS_OBJ_KEY_VAL		Table Type for Object Key-Value pair	20130523
4	Importing	IV_OBJECT_TYPE_ID	Call by reference	☐	Type reference (TYPE)	IF_TFW_TYPES=>OBJECT_TYPE_ID		TFW: Object Type Identifier	20130523

#	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	IT_KEY_VALUE	Call by reference	☐	Type reference (TYPE)	IF_TFW_TYPES=>TS_OBJ_KEY_VAL		Table Type for Object Key-Value pair	20130523
2	Importing	IV_FEAT_KEY	Call by reference	☐	Type reference (TYPE)	TFW_FEAT_KEY		TFW: Feature Name	20130627
3	Importing	IV_OBJECT_TYPE_ID	Call by reference	☐	Type reference (TYPE)	IF_TFW_TYPES=>OBJECT_TYPE_ID		TFW: Object Type Identifier	20130523
4	Returning	RT_RATING_STATS	Value transfer	☐	Type reference (TYPE)	IF_TFW_RATING=>TS_RATING_STAT		Ratings breakdown per feature	20130523

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

Method GET_TAGS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_KEY_VALUE	Call by reference	☐	Type reference (TYPE)	IF_TFW_TYPES=>TS_OBJ_KEY_VAL		Table Type for Object Key-Value pair	20130416
2	Importing	IV_OBJECT_TYPE_ID	Call by reference	☐	Type reference (TYPE)	IF_TFW_TYPES=>OBJECT_TYPE_ID		TFW: Object Type Identifier	20130416
3	Returning	RT_TAG	Value transfer	☐	Type reference (TYPE)	IF_TFW_TAG=>T_TAG		List of tags	20130416

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

Method RESET_BUFFER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_KEY_VALUE	Call by reference	☐	Type reference (TYPE)	IF_TFW_TYPES=>TS_OBJ_KEY_VAL		Table Type for Object Key-Value pair	20130606
2	Importing	IV_META_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	IF_TFW_TYPES=>OBJECT_TYPE		TFW: Object Type ( e.g. Tag, Comment, Rating )	20130606
3	Importing	IV_OBJECT_TYPE_ID	Call by reference	☐	Type reference (TYPE)	IF_TFW_TYPES=>OBJECT_TYPE_ID		TFW: Object Type Identifier	20130606

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

Method UPDATE_COMMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_COMMENT	Call by reference	☐	Type reference (TYPE)	IF_TFW_COMMENT=>S_COMMENT		Comment with updated text	20130417
2	Importing	IT_KEY_VALUE	Call by reference	☐	Type reference (TYPE)	IF_TFW_TYPES=>TS_OBJ_KEY_VAL		Table Type for Object Key-Value pair	20130417
3	Importing	IV_OBJECT_TYPE_ID	Call by reference	☐	Type reference (TYPE)	IF_TFW_TYPES=>OBJECT_TYPE_ID		TFW: Object Type Identifier	20130417
4	Importing	IV_WRITE_THROUGH	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Save the comments to the DB	20130417

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

History

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