SAP ABAP Class CL_RSPLS_WORK_STATUS_BUFFER (Work Status Buffer)

Hierarchy

☛ SAP_BW (Software Component) SAP Business Warehouse
   ⤷ BW-PLA (Application Component) Planning
     ⤷ RSPLS (Package) Planning: General Services

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_RSR_BASE	OLAP Basis	20130422
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_RSPLS_WORK_STATUS_BUFFER	Work Status Buffer	20130807

Properties

Class	CL_RSPLS_WORK_STATUS_BUFFER
Short Description	Work Status Buffer
Super Class	CL_RSR_BASE	OLAP Basis
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status
Category	0
Package	RSPLS	Planning: General Services
Created	20130422	SAP
Last change	20140121	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	CL_RSBPCW_RUNTIME_LOCK_MGR	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
2	IF_RSBPCW_WS_DEF	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
3	IF_RSPLS_DS_TYPES	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
4	IF_RSPLS_LOGGING_ON_SAVE	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
5	IF_RSR_PE_ADAPTER	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
6	RS	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_RSPLS_WORK_STATUS_BUFFER	☐	☐	Work Status Buffer	20130807

Friends

Class CL_RSPLS_WORK_STATUS_BUFFER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	N_BPC_ENV	Instance attribute	Private	☐	Attribute reference (LIKE)				20130912
2	N_BPC_MODEL	Instance attribute	Private	☐	Attribute reference (LIKE)				20130912
3	N_INFOPROV_FIELD	Instance attribute	Private	☐	Attribute reference (LIKE)				20130829
4	N_R_TH_TABLE	Instance attribute	Private	☐	Attribute reference (LIKE)				20130905
5	N_R_WS_DEF	Instance attribute	Private	☐	Attribute reference (LIKE)				20130829
6	N_R_WS_QUERY_HELPER	Instance attribute	Private	☐	Attribute reference (LIKE)				20130902
7	N_R_WS_RUNTIME	Instance attribute	Private	☐	Attribute reference (LIKE)				20130902
8	N_S_SESSION_DRIVER	Instance attribute	Private	☐	Attribute reference (LIKE)				20130829
9	N_S_SESSION_OWN_MAN	Instance attribute	Private	☐	Attribute reference (LIKE)				20130829
10	N_S_SESSION_VIEW	Instance attribute	Private	☐	Attribute reference (LIKE)				20130829
11	N_S_WS_DEF	Instance attribute	Private	☐	Attribute reference (LIKE)				20130902
12	P_C_LOCK_HANDLE	Constant	Private	☐	Type reference (TYPE)	FIELDNAME	'LOCK_HANDLE'	Component name for lock handle	20130904
13	P_DATA_VIEW	Instance attribute	Private	☐	Type reference (TYPE)	TREXD_PLAN_VIEW			20130724
14	P_DEFAULT_STATE	Instance attribute	Private	☐	Type reference (TYPE)	RSBPCW_MODWS		BPC: Module Work Status	20130724
15	P_DRIVER_FIELD	Instance attribute	Private	☐	Type reference (TYPE)	FIELDNAME		Driver dimension field	20130722
16	P_HDB_MODE	Instance attribute	Private	☐	Type reference (TYPE)	RS_BOOL		Boolean	20130724
17	P_R_AREA	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_RSR_OLAP_AREA		Application Area	20130807
18	P_R_MTYPE	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_ABAP_STRUCTDESCR		Runtime Type Services	20130424
19	P_R_PE_ADAPTER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_RSR_PE_ADAPTER			20130422
20	P_R_S_DATA	Instance attribute	Private	☐	Object reference (TYPE REF TO)	DATA		Buffer structure for runtime data slices	20130612
21	P_R_TAB_BUFFER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_RSPLS_TABLE_BUFFER		After image logic for table records	20130807
22	P_R_TH_DATA	Instance attribute	Private	☐	Object reference (TYPE REF TO)	DATA		Buffer table for runtime data slices	20130612
23	P_R_TH_DATA_DRIVER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	DATA		Driver dimension values	20130724
24	P_R_TH_DATA_OWN_MAN	Instance attribute	Private	☐	Object reference (TYPE REF TO)	DATA		Default unlocked data	20130723
25	P_R_TH_ENQUEUE_SET	Instance attribute	Private	☐	Object reference (TYPE REF TO)	DATA		Lock handle for Enqueue set	20130904
26	P_R_T_WS_LOCKS	Instance attribute	Private	☐	Object reference (TYPE REF TO)	DATA		Work Status set	20130920
27	P_TIMESTAMP	Instance attribute	Private	☐	Type reference (TYPE)	RSTIMESTMP		Work Status Time Stamp	20130610
28	P_TSX_LOCK_HNDL	Instance attribute	Private	☐	Type reference (TYPE)	TP_TSX_LOCK_HNDL		List of infoproviders with lock handle	20130618
29	P_TS_FIELDS_MAP	Instance attribute	Private	☐	Type reference (TYPE)	IF_RSBPCW_WS_DEF=>TN_TS_FIELD		Tabelle: Merkmale einer Datenscheibe (interne Sicht)	20130618
30	P_TS_INSTANCE	Static Attribute	Private	☐	Type reference (TYPE)	TP_TS_INSTANCE		Table of instance	20130807
31	P_TS_IOBJ	Instance attribute	Private	☐	Type reference (TYPE)	IF_RSPLS_DS_TYPES=>TN_TS_IOBJ		Tabelle: Merkmale einer Datenscheibe (externe Sicht)	20130829
32	P_TS_IPROV_DS	Instance attribute	Private	☐	Type reference (TYPE)	RSR_TS_INFOPROV		Table of InfoProviders with instantiated dataslice	20130829
33	P_TS_IPROV_NOT_ACT_DS	Instance attribute	Private	☐	Type reference (TYPE)	RSR_TS_INFOPROV		Table of InfoProviders without active dataslice	20130808
34	P_T_INFOPROV	Instance attribute	Private	☐	Type reference (TYPE)	RSBPCA_T_INFOPROV		List of infoprovider	20130618
35	P_T_STATUS_SET	Instance attribute	Private	☐	Type reference (TYPE)	TP_T_STATUS_SET		Work Status and corresponding hierarchy	20130920

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADJUST_SELECTIONS	Instance method	Private	Method	Adjust selection for default state different as 'All'	20130723
2	CLEAR	Instance method	Private	Method		20130829
3	CONSTRUCTOR	Instance method	Public	Constructor		20130422
4	DEQUEUE	Instance method	Private	Method		20130903
5	DEQUEUE_INFOPROV	Instance method	Private	Method	Unlock work status related selection	20130710
6	DEQUEUE_WS_SELECTIONS	Instance method	Private	Method		20130904
7	ENQUEUE	Instance method	Private	Method	Locks providers during work status change	20130906
8	ENQUEUE_INFOPROV	Instance method	Private	Method	Locks providers during work status setting	20130710
9	GET_INSTANCE	Static method	Public	Method	Factory class for WS Buffer	20130807
10	GET_VIRTUAL_PROVIDER_INFO	Instance method	Private	Method	Get virtual provider relevant inforrmantion for locking	20130710
11	GET_WS_DATA	Instance method	Private	Method	Get work status locked data region	20130516
12	IS_HDB_MODE	Instance method	Private	Method	Is the work status running n HDB	20130607
13	READ_DEFAULT_ALL	Instance method	Private	Method	Read after image for the default state All	20130724
14	READ_DEFAULT_LOCKED	Instance method	Private	Method	Read after image for the default state Lock	20130724
15	READ_DEFAULT_OWNER_MANAGER	Instance method	Private	Method	Read after image for the default state Owner or Manager	20130724
16	SET_BUFFER	Instance method	Private	Method	Set data to protected buffer	20130723
17	SET_BUFFER_OWNER_MANAGER	Instance method	Private	Method	Set data to protected buffer	20130724
18	SET_WS_DATA	Instance method	Private	Method	Set work status locked data region	20130425

Events

Class CL_RSPLS_WORK_STATUS_BUFFER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TP_SX_LOCK_HNDL	Private	See coding			20130618	BEGIN OF tp_sx_lock_hndl, hndl TYPE rspls_lock_hndl, ts_iprv_lock TYPE tp_ts_iprv_lock, END OF tp_sx_lock_hndl
2	TP_S_INSTANCE	Private	See coding			20130807	BEGIN OF tp_s_instance, env TYPE rsbpc_appset_id, model TYPE rsbpc_appl_id, r_ws_buffer TYPE REF TO if_rspls_work_status_buffer, END OF tp_s_instance
3	TP_S_IPRV_LOCK	Private	See coding			20130618	BEGIN OF tp_s_iprv_lock, iprv TYPE rsinfoprov, iprv_type TYPE rscubetype, hndl TYPE rspls_lock_hndl, END OF tp_s_iprv_lock
4	TP_S_STATUS_SET	Private	See coding			20130920	BEGIN OF tp_s_status_set, r_ws_locks TYPE REF TO data, r_exp_hier TYPE REF TO data, END OF tp_s_status_set
5	TP_TSX_LOCK_HNDL	Private	See coding			20130618	tp_tsx_lock_hndl TYPE SORTED TABLE OF tp_sx_lock_hndl WITH UNIQUE KEY hndl
6	TP_TS_INSTANCE	Private	See coding			20130807	tp_ts_instance TYPE SORTED TABLE OF tp_s_instance WITH UNIQUE KEY env model
7	TP_TS_IPRV_LOCK	Private	See coding			20130618	tp_ts_iprv_lock TYPE SORTED TABLE OF tp_s_iprv_lock WITH UNIQUE KEY iprv
8	TP_T_STATUS_SET	Private	See coding			20130920	tp_t_status_set TYPE STANDARD TABLE OF tp_s_status_set

Method Signatures

Method ADJUST_SELECTIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_TSX_SEL_POS	Call by reference	☐	Type reference (TYPE)	RSPLS_TS_SEL		Positive selection	20130723
2	Changing	C_T_TSX_SEL_NEG	Call by reference	☐	Type reference (TYPE)	CL_RSBPCW_RUNTIME_LOCK_MGR=>TYT_RSPLS_TS_SEL		Negative Selection	20130723

#	Exception	Resumable	Description	Created on
1	CX_RSPLS_WS_BUFFER_ERROR	☐	Work Status Buffer Error	20130723

Method CLEAR Signature

Method CLEAR on class CL_RSPLS_WORK_STATUS_BUFFER has no parameter.
Method CLEAR on class CL_RSPLS_WORK_STATUS_BUFFER has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_BPC_ENV	Call by reference	☐	Type reference (TYPE)	RSBPC_APPSET_ID		BPC: AppSet ID	20130508
2	Importing	I_BPC_MODEL	Call by reference	☐	Type reference (TYPE)	RSBPC_APPL_ID		BPC: Application ID	20130508
3	Importing	I_R_AREA	Call by reference	☐	Object reference (TYPE REF TO)	CL_RSR_OLAP_AREA		Application Area	20130422

#	Exception	Resumable	Description	Created on
1	CX_RSPLS_WS_BUFFER_ERROR	☐	Work Status Buffer Error	20130807

Method DEQUEUE Signature

Method DEQUEUE on class CL_RSPLS_WORK_STATUS_BUFFER has no parameter.
Method DEQUEUE on class CL_RSPLS_WORK_STATUS_BUFFER has no exception.

Method DEQUEUE_INFOPROV Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ENQMODE	Call by reference	☐	Type reference (TYPE)	ENQMODE	RS_C_ENQMODE-EXCL	Lock Mode	20130710
2	Importing	I_LOCK_HNDL	Call by reference	☑	Type reference (TYPE)	RSPLS_LOCK_HNDL		Handle for Locked Selection	20130710
3	Importing	I_S_INFOPROV	Call by reference	☐	Type reference (TYPE)	TP_S_IPRV_LOCK		Infoprovider info	20130710

Method DEQUEUE_INFOPROV on class CL_RSPLS_WORK_STATUS_BUFFER has no exception.

Method DEQUEUE_WS_SELECTIONS Signature

Method DEQUEUE_WS_SELECTIONS on class CL_RSPLS_WORK_STATUS_BUFFER has no parameter.
Method DEQUEUE_WS_SELECTIONS on class CL_RSPLS_WORK_STATUS_BUFFER has no exception.

Method ENQUEUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_LOCK_HNDL	Call by reference	☐	Type reference (TYPE)	RSPLS_LOCK_HNDL		Handle for Locked Selection	20130906
2	Importing	I_ENQMODE	Call by reference	☐	Type reference (TYPE)	ENQMODE	RS_C_ENQMODE-EXCL	Lock Mode	20130906
3	Importing	I_TSX_SEL	Call by reference	☐	Type reference (TYPE)	RSPLS_TS_SEL		Selection	20131002

#	Exception	Resumable	Description	Created on
1	CX_RSPLS_LOCKED	☐	Lock	20130906

Method ENQUEUE_INFOPROV Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_LOCK_HNDL	Call by reference	☐	Type reference (TYPE)	RSPLS_LOCK_HNDL		Handle for Locked Selection	20130710
2	Importing	I_ENQMODE	Call by reference	☐	Type reference (TYPE)	ENQMODE	RS_C_ENQMODE-EXCL	Lock Mode	20130710
3	Importing	I_S_INFOPROV	Call by reference	☐	Type reference (TYPE)	RSBPCA_S_INFOPROV		Infoprovider	20130710
4	Importing	I_S_LOCK_INFO	Call by reference	☑	Type reference (TYPE)	RSPLS_S_LOCK_INFO		Context Information for Calling Lock: Query, Service	20130710
5	Importing	I_TSX_SEL	Call by reference	☐	Type reference (TYPE)	RSPLS_TS_SEL		Selection	20131002

#	Exception	Resumable	Description	Created on
1	CX_RSPLS_LOCKED	☐	Lock	20130710

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_BPC_ENV	Call by reference	☐	Type reference (TYPE)	RSBPC_APPSET_ID		BPC: AppSet ID	20130807
2	Importing	I_BPC_MODEL	Call by reference	☐	Type reference (TYPE)	RSBPC_APPL_ID		BPC: Application ID	20130807
3	Importing	I_R_AREA	Call by reference	☑	Object reference (TYPE REF TO)	CL_RSR_OLAP_AREA		Application Area	20130807
4	Returning	R_R_WS_BUFFER	Value transfer	☐	Object reference (TYPE REF TO)	IF_RSPLS_WORK_STATUS_BUFFER		Work status buffer	20130807

#	Exception	Resumable	Description	Created on
1	CX_RSPLS_WS_BUFFER_ERROR	☐	Work Status Buffer Error	20130807

Method GET_VIRTUAL_PROVIDER_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_LOCK_METHNM	Call by reference	☐	Type reference (TYPE)	SEOMTDNAME		Method name	20130710
2	Exporting	E_SVSID	Call by reference	☐	Type reference (TYPE)	RSCUBESVSID		SID Support (InfoProvider)	20130710
3	Exporting	E_WRITECLASSNM	Call by reference	☐	Type reference (TYPE)	RSDWRITECLASNM		Name of Class for Write Interface	20130710
4	Importing	I_INFOPROV	Call by reference	☐	Type reference (TYPE)	RSINFOPROV		InfoProvider	20130710
5	Importing	I_METH_TYPE	Call by reference	☐	Type reference (TYPE)	CHAR1		ENQUEUE/DEQUEUE indicator	20130710

Method GET_VIRTUAL_PROVIDER_INFO on class CL_RSPLS_WORK_STATUS_BUFFER has no exception.

Method GET_WS_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_TH_DATA	Call by reference	☐	Type reference (TYPE)	HASHED TABLE			20130516
2	Importing	I_TSX_SEL	Call by reference	☐	Type reference (TYPE)	RSPLS_TS_SEL		Selection	20130516

#	Exception	Resumable	Description	Created on
1	CX_RSPLS_WS_BUFFER_ERROR	☐	Work Status Buffer Error	20130613

Method IS_HDB_MODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_HDB_MODE	Value transfer	☐	Type reference (TYPE)	RS_BOOL		Boolean	20130607

Method IS_HDB_MODE on class CL_RSPLS_WORK_STATUS_BUFFER has no exception.

Method READ_DEFAULT_ALL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_TSX_SEL_POS	Call by reference	☐	Type reference (TYPE)	RSPLS_TS_SEL		Positive selection	20130724
2	Importing	I_T_TSX_SEL_NEG	Call by reference	☐	Type reference (TYPE)	CL_RSBPCW_RUNTIME_LOCK_MGR=>TYT_RSPLS_TS_SEL		Negative Selection	20130724
3	Returning	R_IS_OVERLAPPING	Value transfer	☐	Type reference (TYPE)	RS_BOOL		Boolean	20130808

#	Exception	Resumable	Description	Created on
1	CX_RSPLS_WS_BUFFER_ERROR	☐	Work Status Buffer Error	20130724

Method READ_DEFAULT_LOCKED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_TSX_SEL_POS	Call by reference	☐	Type reference (TYPE)	RSPLS_TS_SEL		Positive selection	20130724
2	Importing	I_T_TSX_SEL_NEG	Call by reference	☐	Type reference (TYPE)	CL_RSBPCW_RUNTIME_LOCK_MGR=>TYT_RSPLS_TS_SEL		Negative Selection	20130724
3	Returning	R_IS_OVERLAPPING	Value transfer	☐	Type reference (TYPE)	RS_BOOL		Boolean	20130808

#	Exception	Resumable	Description	Created on
1	CX_RSPLS_WS_BUFFER_ERROR	☐	Work Status Buffer Error	20130724

Method READ_DEFAULT_OWNER_MANAGER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_TSX_SEL_DEF_UNLOCK	Call by reference	☐	Type reference (TYPE)	RSPLS_TS_SEL		Default unlocked selection	20130724
2	Importing	I_TSX_SEL_POS	Call by reference	☐	Type reference (TYPE)	RSPLS_TS_SEL		Positive selection	20130724
3	Importing	I_T_TSX_SEL_NEG	Call by reference	☐	Type reference (TYPE)	CL_RSBPCW_RUNTIME_LOCK_MGR=>TYT_RSPLS_TS_SEL		Negative Selection	20130724
4	Returning	R_IS_OVERLAPPING	Value transfer	☐	Type reference (TYPE)	RS_BOOL		Boolean	20130808

#	Exception	Resumable	Description	Created on
1	CX_RSPLS_WS_BUFFER_ERROR	☐	Table Buffer Error	20130724

Method SET_BUFFER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_NEW_DATA	Call by reference	☑	Type reference (TYPE)	RS_BOOL		Boolean	20130723
2	Importing	I_S_SESSION_VIEW	Call by reference	☑	Type reference (TYPE)	IF_RSR_PE_ADAPTER=>TN_S_PE_SESSION_VIEW_ID		Calculation View Representing Planning Operation Result	20130723
3	Importing	I_TH_COMPLEMENT	Call by reference	☑	Type reference (TYPE)	HASHED TABLE			20130723
4	Importing	I_TH_DATA	Call by reference	☐	Type reference (TYPE)	HASHED TABLE			20130723
5	Importing	I_TH_DEF_UNLOCK	Call by reference	☑	Type reference (TYPE)	HASHED TABLE			20130723

#	Exception	Resumable	Description	Created on
1	CX_RSPLS_WS_BUFFER_ERROR	☐	Work Status Buffer Error	20130723

Method SET_BUFFER_OWNER_MANAGER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_S_SESSION_OWN_MAN	Call by reference	☑	Type reference (TYPE)	IF_RSR_PE_ADAPTER=>TN_S_PE_SESSION_VIEW_ID		Calculation View Representing Planning Operation Result	20130724
2	Importing	I_TH_DATA_DRIVER	Call by reference	☑	Type reference (TYPE)	HASHED TABLE			20130724
3	Importing	I_TH_DATA_OWN_MAN	Call by reference	☐	Type reference (TYPE)	HASHED TABLE			20130724

#	Exception	Resumable	Description	Created on
1	CX_RSPLS_WS_BUFFER_ERROR	☐	Work Status Buffer Error	20130724

Method SET_WS_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_TH_DATA	Call by reference	☐	Type reference (TYPE)	HASHED TABLE		The name to be changed!!! Table with entries to be locked	20130605
2	Importing	I_TSX_SEL_POS	Call by reference	☑	Type reference (TYPE)	RSPLS_TS_SEL		Selection	20130606
3	Importing	I_T_TSX_SEL_NEG	Call by reference	☑	Type reference (TYPE)	CL_RSBPCW_RUNTIME_LOCK_MGR=>TYT_RSPLS_TS_SEL		Selection	20130606

#	Exception	Resumable	Description	Created on
1	CX_RSPLS_WS_BUFFER_ERROR	☐	Work Status Buffer Error	20130613

History

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