SAP ABAP Interface IF_RSR_OLAP_PLAN (OLAP planning)

Hierarchy

☛ SAP_BW (Software Component) SAP Business Warehouse
   ⤷ BW-BEX-OT (Application Component) OLAP Technology
     ⤷ RSROA_SHELL (Package) OLAP: Instance Administration, Initialization

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	CL_RSR_OLAP_PLAN	OLAP planning	20120727

Properties

Interface	IF_RSR_OLAP_PLAN
Short Description	OLAP planning

General Data

Package	RSROA_SHELL	OLAP: Instance Administration, Initialization
Created	20120727	SAP
Last changed	20140121	SAP
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	RRX1	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
2	RS	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Interface IF_RSR_OLAP_PLAN has no interface.

Friends

Interface IF_RSR_OLAP_PLAN has no friend.

Attributes

Interface IF_RSR_OLAP_PLAN has no attribute.

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_INPUTABLE	Instance method	Public	Method	Check Ready for Input Status	20120727
2	CREATE_PLAN_PROPOSAL	Instance method	Public	Method	Generates Proposal from Planning Customizing	20120727
3	GET_DATA_FLAT_PLAN_DATA	Instance method	Public	Method	Fetch from Report Data in a E_T_DATA	20120727
4	GET_INPUTABLE_DAT_N	Instance method	Public	Method	Template for New Rows in Plan Query	20120727
5	GET_PLAN_DELTA	Instance method	Public	Method	Get changed cell values, list geometry unchanged	20130108
6	HAS_PLAN_EMPTY	Instance method	Public	Method	Query Supports Plan Empty	20120727
7	PROCESS_INPUT	Instance method	Public	Method	Processes modified data from the client	20120727
8	SET_NEW_VALUES	Instance method	Public	Method	Planning, Write New Key Figure Values	20120727
9	SYNC_PLANNING_STATE	Instance method	Public	Method	Synchronization for Planning Before Retrieving Data	20120727

Events

Interface IF_RSR_OLAP_PLAN has no event.

Types

Interface IF_RSR_OLAP_PLAN has no local type.

Method Signatures

Method CHECK_INPUTABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_R_DAT_N	Call by reference	☐	Object reference (TYPE REF TO)	DATA			20120727
2	Importing	I_R_SETXX_COLS	Call by reference	☑	Object reference (TYPE REF TO)	DATA			20120727
3	Importing	I_R_SETXX_DATA	Call by reference	☑	Object reference (TYPE REF TO)	DATA			20120727
4	Importing	I_R_SETXX_ROWS	Call by reference	☑	Object reference (TYPE REF TO)	DATA			20120727
5	Importing	I_SX_REQ_KIDS	Call by reference	☐	Type reference (TYPE)	RRK0_SX_KID_SELECTION			20120727
6	Importing	I_TS_AXES_CI	Call by reference	☐	Type reference (TYPE)	RRK0_TS_AXES_CI		Characteristics and Axes for Test of Input Readiness	20120727

#	Exception	Resumable	Description	Created on
1	CX_RSR_BAD_VALUE_COMBINATION	☐	Invalid Variable Value	20121108
2	CX_RS_NOT_AUTHORIZED	☐	No Authorization (Do Not Use as Higher-Level Class)	20121108

Method CREATE_PLAN_PROPOSAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CHANMID	Call by reference	☐	Type reference (TYPE)	RRCHANMID		Internal ID of the CHANM	20120727
2	Importing	I_TSX_SELDR	Call by reference	☑	Type reference (TYPE)	RSDD_TSX_SELDR		Selection to the Data Manager	20120727
3	Returning	R_SX_SELDR	Value transfer	☐	Type reference (TYPE)	RSDD_SX_SELDR		Selection to the Data Manager	20120727

#	Exception	Resumable	Description	Created on
1	CX_RSROA_EMPTY	☐	Empty Result	20120727
2	CX_RSROA_NOT_SUPPORTED	☐	OLAP: Not Supported	20120727
3	CX_RSR_BAD_VALUE_COMBINATION	☐	Invalid Variable Value	20121108
4	CX_RS_NOT_AUTHORIZED	☐	No Authorization (Do Not Use as Higher-Level Class)	20121108

Method GET_DATA_FLAT_PLAN_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_S_DATA	Call by reference	☐	Type reference (TYPE)	ANY			20120727
2	Exporting	E_T_DATA	Call by reference	☐	Type reference (TYPE)	ANY TABLE			20120727
3	Importing	I_INTFORMAT	Value transfer	☐	Type reference (TYPE)	RSCUBESVINTFORMAT	RS_C_TRUE	Internal Format (Key Figures)	20120727
4	Importing	I_NOZERO	Call by reference	☐	Type reference (TYPE)	RRXNOZERO	RS_C_FALSE	Flag for zero suppression	20120727
5	Importing	I_R_D	Call by reference	☐	Object reference (TYPE REF TO)	CL_ABAP_STRUCTDESCR		Key Figure MOVE	20120727
6	Importing	I_R_K	Call by reference	☐	Object reference (TYPE REF TO)	CL_ABAP_STRUCTDESCR		Characteristic MOVE	20120727
7	Importing	I_SX_REQ_KIDS	Call by reference	☐	Type reference (TYPE)	RRK0_SX_KID_SELECTION			20120727
8	Importing	I_TS_DPOS	Call by reference	☐	Type reference (TYPE)	RSR_TS_DPOS		Positions of the KIDs in the S_DATA	20130729
9	Importing	I_TS_NAV	Call by reference	☐	Type reference (TYPE)	RRSI_TS_SID		SID (or Integer) Table	20120727

#	Exception	Resumable	Description	Created on
1	CX_RSROA_EMPTY	☐	Empty Result	20120727
2	CX_RSROA_STEP_FAILED	☐	Exception without text, other navigation step possible	20120727
3	CX_RSR_BAD_VALUE_COMBINATION	☐	Invalid Variable Value	20121108
4	CX_RS_NOT_AUTHORIZED	☐	No Authorization (Do Not Use as Higher-Level Class)	20121108

Method GET_INPUTABLE_DAT_N Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_NOINPUT	Call by reference	☐	Type reference (TYPE)	RS_BOOL		Boolean	20120727
2	Exporting	E_TH_DAT_N	Call by reference	☐	Type reference (TYPE)	RRX1_TH_DAT_N			20120727
3	Importing	I_SX_REQ_KIDS	Call by reference	☐	Type reference (TYPE)	RRK0_SX_KID_SELECTION			20120727
4	Importing	I_TS_AXES_CI	Call by reference	☐	Type reference (TYPE)	RRK0_TS_AXES_CI		Characteristics and Axes for Test of Input Readiness	20120727

#	Exception	Resumable	Description	Created on
1	CX_RSR_BAD_VALUE_COMBINATION	☐	Invalid Variable Value	20121108
2	CX_RS_NOT_AUTHORIZED	☐	No Authorization (Do Not Use as Higher-Level Class)	20121108

Method GET_PLAN_DELTA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_TH_DAT_N	Call by reference	☐	Type reference (TYPE)	RRX1_TH_DAT_N		cell values of plan delta	20130108
2	Exporting	E_TH_SETXX_DATA	Call by reference	☐	Type reference (TYPE)	HASHED TABLE		SETXX for plan delta	20130108

#	Exception	Resumable	Description	Created on
1	CX_RSR_BAD_VALUE_COMBINATION	☐	Invalid Variable Value	20130108
2	CX_RS_NOT_AUTHORIZED	☐	No Authorization (Do Not Use as Higher-Level Class)	20130108

Method HAS_PLAN_EMPTY Signature

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

Method HAS_PLAN_EMPTY on Interface IF_RSR_OLAP_PLAN has no exception.

Method PROCESS_INPUT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_T_INPUTXX	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE		Changed/New Cells	20120727
2	Exporting	E_R_T_INPUTXX	Call by reference	☐	Type reference (TYPE)	DATA		Changed/New Cells after Disaggregation	20120727
3	Exporting	E_TS_SNV	Call by reference	☐	Type reference (TYPE)	RRK0_TS_SNV		Description of the SET_NEW_VALUES INPUTXX	20120727
4	Importing	I_DELTA_PREFERRED	Call by reference	☐	Type reference (TYPE)	RS_BOOL	RS_C_FALSE	Create a delta result set, if possible	20121102
5	Importing	I_R_T_MESG	Call by reference	☐	Object reference (TYPE REF TO)	RS_T_MSG		Message Log with Context	20120727
6	Importing	I_TS_RS_ACCESS_MODE	Call by reference	☐	Type reference (TYPE)	RRO01_TS_RS_ACCESS_MODE		Process Type Settings for Result Values by Characteristic	20120727
7	Importing	I_TS_SNV	Call by reference	☐	Type reference (TYPE)	RRK0_TS_SNV		Description of the SET_NEW_VALUES INPUTXX	20120727

#	Exception	Resumable	Description	Created on
1	CX_RSR_BAD_VALUE_COMBINATION	☐	Invalid Variable Value	20121108
2	CX_RS_ERROR	☐	BW: General Error Class	20120727
3	CX_RS_NOT_AUTHORIZED	☐	No Authorization (Do Not Use as Higher-Level Class)	20121108

Method SET_NEW_VALUES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_T_INPUTXX	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE			20120727
2	Importing	I_R_TEXT	Call by reference	☑	Object reference (TYPE REF TO)	DATA			20120727
3	Importing	I_R_T_MESG	Call by reference	☑	Object reference (TYPE REF TO)	RS_T_MSG		BW: Table with Messages (Application Log)	20120727
4	Importing	I_TS_RS_ACCESS_MODE	Call by reference	☑	Type reference (TYPE)	RRO01_TS_RS_ACCESS_MODE			20120727
5	Importing	I_TS_SNV	Call by reference	☑	Type reference (TYPE)	RRK0_TS_SNV		Description of the SET_NEW_VALUES INPUTXX	20120727

#	Exception	Resumable	Description	Created on
1	CX_RSPLS_DERIVE_ERROR	☐	Error in Characteristic Derivation	20120727
2	CX_RSPLS_INPUT_ERROR	☐	Error in Input Logic	20120727
3	CX_RSROA_NO_INPUT	☐	No Cell Input Ready	20120727
4	CX_RSR_BAD_VALUE_COMBINATION	☐	Invalid Variable Value	20121108
5	CX_RS_NOT_AUTHORIZED	☐	No Authorization (Do Not Use as Higher-Level Class)	20121108

Method SYNC_PLANNING_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_THX_SLICER	Call by reference	☐	Type reference (TYPE)	RRK0_THX_SLICER		Dynamic Filter	20120727
2	Importing	I_TS_AXES_CI	Call by reference	☐	Type reference (TYPE)	RRK0_TS_AXES_CI		Characteristics and Axes for Test of Input Readiness	20120727

#	Exception	Resumable	Description	Created on
1	CX_RSR_BAD_VALUE_COMBINATION	☐	Invalid Variable Value	20121108
2	CX_RS_NOT_AUTHORIZED	☐	No Authorization (Do Not Use as Higher-Level Class)	20121108

History

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