SAP ABAP Class CL_RSL_STW_INT (STW Integration)

Hierarchy

☛ SAP_BW (Software Component) SAP Business Warehouse
   ⤷ BW-BEX-OT (Application Component) OLAP Technology
     ⤷ RSL_STREAMWORK (Package) Services for SAP StreamWork Integration

Properties

Class	CL_RSL_STW_INT
Short Description	STW Integration
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	RSL_STREAMWORK	Services for SAP StreamWork Integration
Created	20111123	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	IF_STW_ACTIVITY	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
2	IF_STW_ITEM	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
3	IF_STW_ITEM_TEXT	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
4	IF_STW_USER	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

Class CL_RSL_STW_INT has no interface implemented.

Friends

Class CL_RSL_STW_INT has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	N_C_APPLICATION_ID	Constant	Public	☐	Type reference (TYPE)	CLB_APPLICATION_ID	'BW_WORKSPACES'	Stw Application	20120104
2	N_C_USERSTATUS	Constant	Public	☐	See coding				20120104
3	O_ACTID	Instance attribute	Protected	☐	Type reference (TYPE)	STW_ACTIVITY_ID		Activity ID	20120104
4	O_ITEM_TEXTID	Instance attribute	Protected	☐	Type reference (TYPE)	STW_ITEM_ID		TextitemID	20120117
5	O_R_ACTIVITY	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_STW_ACTIVITY		activity reference	20120104
6	O_R_ITEM_TEXT	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_STW_ITEM_TEXT		text item reference	20120104
7	O_R_STW_API	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_STW_API		application reference	20120117
8	P_COPR_NAME	Instance attribute	Private	☐	Type reference (TYPE)	RSCOMPNAME		COPR Name	20120104
9	P_WSP_NAME	Instance attribute	Private	☐	Type reference (TYPE)	RSLWSPNAME		WSP Name	20120104

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ACTIVITY_MARK_AS_COMPL	Instance method	Public	Method	Mark Activity as complete	20120117
2	ADD_COMMENT	Instance method	Public	Method	Comment for Central Text Item	20120104
3	CHECK_CREATION_CHANGE_POSSIBLE	Static method	Public	Method	Check if activity can be created	20120117
4	CHECK_STW_AVAILABILITY	Static method	Public	Method	Check SAP StreamWork Availability	20120104
5	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20120104
6	CREATE_ACTIVITY	Instance method	Public	Method	create new stw activity	20120104
7	DELETE_ACTIVITY	Instance method	Public	Method	Archive Activity	20120104
8	FREE	Instance method	Public	Method	Performs an update on the activity	20120118
9	GET_ACTIVITY_DETAILS	Instance method	Public	Method	show stw activity	20120104
10	GET_ACTIVITY_ID	Instance method	Public	Method	Get current Stw activity ID	20120104
11	GET_ACTIVITY_STATUS	Instance method	Public	Method	Get Activity Status	20120104
12	GET_ACTIVITY_URL	Instance method	Public	Method	Get Activity URL	20120104
13	GET_PARTICIPANTS	Instance method	Public	Method	Activity Participants	20120104
14	GET_URL_BY_COMPPROV	Static method	Public	Method	Get Stw Activity URL by Compprov	20120104
15	INVITE_PARTICIPANT	Instance method	Public	Method	Invite participant to activity	20120104
16	REMOVE_PARTICIPANT	Instance method	Public	Method	Remove Participant	20120104
17	SET_ACTIVITY_STATUS	Instance method	Public	Method	Set Activity Status	20120104
18	_CREATE_ASSIGNMENT	Instance method	Private	Method	Assign stw activity to bw workspace object	20120104
19	_CREATE_ITEM_TEXT	Instance method	Private	Method	Create stw text item	20120104
20	_DELETE_ASSIGNMENT	Static method	Private	Method	Delete assignment of stw activity to bw workspace object	20120104
21	_GET_ACTIVITY	Instance method	Private	Method	get activity instance	20120104
22	_GET_ASSIGNMENT	Static method	Private	Method	Get assignment of stw activity to bw workspace object	20120104
23	_GET_ITEM_TEXT	Instance method	Private	Method	get text item instance	20120104
24	_GET_ITEM_TEXT_TEXTS	Instance method	Private	Method	Returns texts for text item	20120117

Events

Class CL_RSL_STW_INT has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	GS_ACTIVITY	Public	See coding			20120104	begin of gs_activity, activity_name TYPE STW_ACTIVITY_NAME, activity_creator_name TYPE STW_USER_SW_name, activity_owner_id TYPE STW_USER_SW_ID, activity_owner_name TYPE STW_USER_SW_name, activity_sharing TYPE STW_ACTIVITY_SHARING, activity_status TYPE STW_ACTIVITY_STATUS, activity_privacy TYPE STW_ACTIVITY_PRIVACY, activity_purpose TYPE stw_activity_purpose, activity_created_at TYPE stw_activity_created_at, activity_updated_at TYPE stw_activity_updated_at, end of gs_activity
2	GS_PARTICIPANT	Public	See coding			20120104	begin of gs_participant, email TYPE stw_user_sw_email, name TYPE stw_user_sw_name, sw_id TYPE stw_user_sw_id, backend_user_id TYPE IF_STW_USER=>TV_BACKEND_USER_ID, userstatus(1) TYPE c, is_owner TYPE rs_bool, stw_user TYPE REF TO if_stw_user, end of gs_participant
3	GT_PARTICIPANT	Public	See coding			20120104	gt_participant type standard table of gs_participant
4	TN_S_EMAILADD	Public	See coding			20120117	BEGIN OF tn_s_emailadd, email TYPE if_stw_user=>tv_sw_user_email, END OF tn_s_emailadd
5	TN_T_EMAILADD	Public	See coding			20120117	tn_t_emailadd TYPE STANDARD TABLE OF tn_s_emailadd

Method Signatures

Method ACTIVITY_MARK_AS_COMPL Signature

Method ACTIVITY_MARK_AS_COMPL on class CL_RSL_STW_INT has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_RSL_STW	☐	BW Workspace Stw Integraton	20120117

Method ADD_COMMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_COMMENT	Call by reference	☐	Type reference (TYPE)	STRING			20120104

#	Exception	Resumable	Description	Created on
1	CX_RSL_STW	☐	BW Workspace Stw Integraton	20120104

Method CHECK_CREATION_CHANGE_POSSIBLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_BACKEND_USER_ID	Call by reference	☐	Type reference (TYPE)	IF_STW_USER=>TV_BACKEND_USER_ID		Backend User ID	20120117
2	Importing	I_COMPPROV	Call by reference	☐	Type reference (TYPE)	RSCOMPNAME		composite provider	20120117
3	Importing	I_WSP	Call by reference	☐	Type reference (TYPE)	RSLWSPNAME		Workspace Name	20120117
4	Returning	R_POSSIBLE	Value transfer	☐	Type reference (TYPE)	RS_BOOL			20120117

#	Exception	Resumable	Description	Created on
1	CX_RSL_STW	☐	BW Workspace Stw Integraton	20120117

Method CHECK_STW_AVAILABILITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	IS_AVAILABLE	Value transfer	☐	Type reference (TYPE)	RS_BOOL		STW Availability	20120104

Method CHECK_STW_AVAILABILITY on class CL_RSL_STW_INT has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_COPRNM	Call by reference	☐	Type reference (TYPE)	RSCOMPNAME		COPR	20120104
2	Importing	I_WSPNM	Call by reference	☑	Type reference (TYPE)	RSLWSPNAME		WSP	20120104

#	Exception	Resumable	Description	Created on
1	CX_RSL_STW	☐	BW Workspace Stw Integraton	20120104

Method CREATE_ACTIVITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ACTPRIVACY	Call by reference	☐	Type reference (TYPE)	IF_STW_ACTIVITY=>TV_ACTIVITY_PRIVACY		activity privacy (public, private, confident)	20120104
2	Importing	I_ACTPURPOSE	Call by reference	☑	Type reference (TYPE)	IF_STW_ACTIVITY=>TV_ACTIVITY_PURPOSE		actiivity purpose	20120104
3	Importing	I_ACTSHARING	Call by reference	☐	Type reference (TYPE)	IF_STW_ACTIVITY=>TV_ACTIVITY_SHARING		Allow participants to invite others to this activity	20120104
4	Importing	I_ACTTEMPID	Call by reference	☑	Type reference (TYPE)	IF_STW_ACTIVITY=>TV_ACTIVITY_TEMPLATE_ID		Tempate ID	20120104
5	Importing	I_ACTTITLE	Call by reference	☐	Type reference (TYPE)	IF_STW_ACTIVITY=>TV_ACTIVITY_NAME		activity name	20120104
6	Importing	I_TXTCONTACT1	Call by reference	☐	Type reference (TYPE)	STRING		TXT contact1	20120118
7	Importing	I_TXTCONTACT2	Call by reference	☐	Type reference (TYPE)	STRING		TXT contact2	20120118
8	Importing	I_TXTCOPRCREATAT	Call by reference	☐	Type reference (TYPE)	STRING		TXT CompositeProvider created at	20120118
9	Importing	I_TXTCOPRCREATBY	Call by reference	☐	Type reference (TYPE)	STRING		TXT CompositeProvider created by	20120118
10	Importing	I_TXTCOPRDESCR	Call by reference	☐	Type reference (TYPE)	STRING		TXT CompositeProvider Description	20120118
11	Importing	I_TXTWSPDESCR	Call by reference	☐	Type reference (TYPE)	STRING		TXT Workspace Description	20120118
12	Importing	I_URLTONWBC	Call by reference	☑	Type reference (TYPE)	STRING		Jump from StreamWork to NWBC	20120104

#	Exception	Resumable	Description	Created on
1	CX_RSL_STW	☐	BW Workspace Stw Integraton	20120104

Method DELETE_ACTIVITY Signature

Method DELETE_ACTIVITY on class CL_RSL_STW_INT has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_RSL_STW	☐	BW Workspace Stw Integraton	20120104

Method FREE Signature

Method FREE on class CL_RSL_STW_INT has no parameter.
Method FREE on class CL_RSL_STW_INT has no exception.

Method GET_ACTIVITY_DETAILS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_S_ACTIVITY	Call by reference	☐	Type reference (TYPE)	GS_ACTIVITY		Activity Details Structure	20120104

#	Exception	Resumable	Description	Created on
1	CX_RSL_STW	☐	BW Workspace Stw Integraton	20120104

Method GET_ACTIVITY_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_ACTID	Call by reference	☐	Type reference (TYPE)	STW_ACTIVITY_ID			20120104

Method GET_ACTIVITY_ID on class CL_RSL_STW_INT has no exception.

Method GET_ACTIVITY_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_ACTSTAT	Value transfer	☐	Type reference (TYPE)	STW_ACTIVITY_STATUS		Activity Status	20120104

#	Exception	Resumable	Description	Created on
1	CX_RSL_STW	☐	BW Workspace Stw Integraton	20120104

Method GET_ACTIVITY_URL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	E_URL	Value transfer	☐	Type reference (TYPE)	STRING		Activity URL	20120104

#	Exception	Resumable	Description	Created on
1	CX_RSL_STW	☐	BW Workspace Stw Integraton	20120104

Method GET_PARTICIPANTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_T_PARTICIPANTS	Call by reference	☐	Type reference (TYPE)	GT_PARTICIPANT		Participant List	20120104
2	Exporting	E_T_R_PARTICIPANT	Call by reference	☐	Type reference (TYPE)	IF_STW_USER=>TT_SW_USER		List of Stream Users	20120117

#	Exception	Resumable	Description	Created on
1	CX_RSL_STW	☐	BW Workspace Stw Integraton	20120104

Method GET_URL_BY_COMPPROV Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	E_URL	Value transfer	☐	Type reference (TYPE)	STRING		Activity URL	20120104
2	Importing	I_COMPPROV	Call by reference	☐	Type reference (TYPE)	RSCOMPNAME		Composite Provider	20120104

Method GET_URL_BY_COMPPROV on class CL_RSL_STW_INT has no exception.

Method INVITE_PARTICIPANT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_ACTEM	Call by reference	☐	Type reference (TYPE)	TN_T_EMAILADD		user email table	20120104

#	Exception	Resumable	Description	Created on
1	CX_RSL_STW	☐	BW Workspace Stw Integraton	20120104

Method REMOVE_PARTICIPANT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_T_EMAILADD	Call by reference	☐	Type reference (TYPE)	TN_T_EMAILADD			20120117

#	Exception	Resumable	Description	Created on
1	CX_RSL_STW	☐	BW Workspace Stw Integraton	20120104

Method SET_ACTIVITY_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ACTSTAT	Call by reference	☐	Type reference (TYPE)	STW_ACTIVITY_STATUS		Activity Status	20120104

#	Exception	Resumable	Description	Created on
1	CX_RSL_STW	☐	BW Workspace Stw Integraton	20120104

Method _CREATE_ASSIGNMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ACTID	Call by reference	☐	Type reference (TYPE)	STW_ACTIVITY_ID		STW Activity ID	20120104
2	Importing	I_COMPPROV	Call by reference	☐	Type reference (TYPE)	RSCOMPNAME		Composite Provider	20120104
3	Importing	I_TEXTID	Call by reference	☐	Type reference (TYPE)	STW_ITEM_ID			20120104
4	Importing	I_WORKSPACE	Call by reference	☐	Type reference (TYPE)	RSLWSPNAME		Workspace Name	20120104

Method _CREATE_ASSIGNMENT on class CL_RSL_STW_INT has no exception.

Method _CREATE_ITEM_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_TXTCONTACT1	Call by reference	☐	Type reference (TYPE)	STRING		TXT contact1	20120118
2	Importing	I_TXTCONTACT2	Call by reference	☐	Type reference (TYPE)	STRING		TXT contact2	20120118
3	Importing	I_TXTCOPRCREATAT	Call by reference	☐	Type reference (TYPE)	STRING		TXT CompositeProvider created at	20120118
4	Importing	I_TXTCOPRCREATBY	Call by reference	☐	Type reference (TYPE)	STRING		TXT CompositeProvider created by	20120118
5	Importing	I_TXTCOPRDESCR	Call by reference	☐	Type reference (TYPE)	STRING		TXT CompositeProvider Description	20120118
6	Importing	I_TXTPURPOSE	Call by reference	☐	Type reference (TYPE)	STRING		TXT content	20120118
7	Importing	I_TXTWSPDESCR	Call by reference	☐	Type reference (TYPE)	STRING		TXT Workspace Description	20120118

#	Exception	Resumable	Description	Created on
1	CX_RSL_STW	☐	BW Workspace Stw Integraton	20120104

Method _DELETE_ASSIGNMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_COMPPROV	Call by reference	☐	Type reference (TYPE)	RSCOMPNAME		Composite Provider	20120104

Method _DELETE_ASSIGNMENT on class CL_RSL_STW_INT has no exception.

Method _GET_ACTIVITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_R_ACTIVITY	Call by reference	☐	Object reference (TYPE REF TO)	IF_STW_ACTIVITY			20120117

#	Exception	Resumable	Description	Created on
1	CX_RSL_STW	☐	BW Workspace Stw Integraton	20120104

Method _GET_ASSIGNMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_ACTID	Call by reference	☐	Type reference (TYPE)	STW_ACTIVITY_ID		activity id	20120104
2	Exporting	E_ITEM_TEXTID	Call by reference	☐	Type reference (TYPE)	STW_ITEM_ID			20120117
3	Importing	I_COPRNM	Call by reference	☐	Type reference (TYPE)	RSCOMPNAME		Composite Provider	20120117
4	Importing	I_WSPNM	Call by reference	☑	Type reference (TYPE)	RSLWSPNAME		Workspace Name	20120117

#	Exception	Resumable	Description	Created on
1	CX_RSL_STW	☐	BW Workspace Stw Integraton	20120104

Method _GET_ITEM_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_R_ITEM_TEXT	Call by reference	☐	Object reference (TYPE REF TO)	IF_STW_ITEM_TEXT			20120117

#	Exception	Resumable	Description	Created on
1	CX_RSL_STW	☐	BW Workspace Stw Integraton	20120104

Method _GET_ITEM_TEXT_TEXTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_ABOUT	Call by reference	☐	Type reference (TYPE)	IF_STW_ITEM=>TV_ITEM_DESCRIPTION		StreamWork Item Descripton ( About )	20120118
2	Exporting	E_CONTENT	Call by reference	☐	Type reference (TYPE)	IF_STW_ITEM_TEXT=>TV_TEXT			20120117
3	Exporting	E_NAME	Call by reference	☐	Type reference (TYPE)	IF_STW_ITEM=>TV_ITEM_NAME		StreamWork Item Name	20120117
4	Importing	I_TXTCONTACT1	Call by reference	☐	Type reference (TYPE)	STRING		TXT contact1	20120118
5	Importing	I_TXTCONTACT2	Call by reference	☐	Type reference (TYPE)	STRING		TXT contact2	20120118
6	Importing	I_TXTCOPRCREATAT	Call by reference	☐	Type reference (TYPE)	STRING		TXT CompositeProvider created at	20120118
7	Importing	I_TXTCOPRCREATBY	Call by reference	☐	Type reference (TYPE)	STRING		TXT CompositeProvider created by	20120118
8	Importing	I_TXTCOPRDESCR	Call by reference	☐	Type reference (TYPE)	STRING		TXT CompositeProvider Description	20120118
9	Importing	I_TXTPURPOSE	Call by reference	☐	Type reference (TYPE)	STRING		TXT content	20120118
10	Importing	I_TXTWSPDESCR	Call by reference	☐	Type reference (TYPE)	STRING		TXT Workspace Description	20120118

#	Exception	Resumable	Description	Created on
1	CX_RSL_STW	☐	BW Workspace Stw Integraton	20120117

History

Last changed by/on	SAP	20130531
SAP Release Created in