SAP ABAP Interface IF_RSBPCW_WS_DEF (Work Status Defintion)

Hierarchy

☛ SAP_BW (Software Component) SAP Business Warehouse
   ⤷ BW-PLA-BPC-WS (Application Component) BPC 'unified model' - Work Status
     ⤷ RSBPCW (Package) BPC IP Extension: Work Status

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	CL_RSBPCW_WS_DEF	BPC IP Extension: Work Status Definition	20130607

Properties

Interface	IF_RSBPCW_WS_DEF
Short Description	Work Status Defintion

General Data

Package	RSBPCW	BPC IP Extension: Work Status
Created	20130607	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	CL_RSBPCW_CONST	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
3	RS	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Interface IF_RSBPCW_WS_DEF has no interface.

Friends

Interface IF_RSBPCW_WS_DEF has no friend.

Attributes

Interface IF_RSBPCW_WS_DEF has no attribute.

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	GET_COMP_STATE	Instance method	Public	Method	Get Component State	20130607
2	GET_DEFAULT_STATE	Instance method	Public	Method	Get State of Default Work Status	20130715
3	GET_FIELD_MAPPING	Instance method	Public	Method	Get Field Mapping for Lock Dimension	20130607
4	GET_INFO	Instance method	Public	Method	Get Information	20130607
5	GET_LOCK_METADATA	Instance method	Public	Method	Get Lock Meta Data (for Data Slicer)	20130607
6	GET_RUNTIME_MGR	Instance method	Public	Method	Get Runtime Manager for Work Status	20130607
7	GET_SCRIPT_INFO	Instance method	Public	Method		20130723
8	GET_WS_DATA_TABLE	Instance method	Public	Method	Get Work Status Table	20130607
9	GET_WS_RUNTIME	Instance method	Public	Method	Get Runtime Manager for Work Status	20130713
10	SET_EMAIL_CFG	Instance method	Public	Method	Set Email Notification Definition	20130725
11	SET_ENABLE_FLAG	Instance method	Public	Method	Set Enable Flag	20130705
12	SET_LOCK_DIMS	Instance method	Public	Method	Set Lock Dimension for Work Status	20130607
13	SET_WORK_STATE	Instance method	Public	Method	Set Work State	20130607
14	VALIDATE_DIM	Instance method	Public	Method	Validate lock dimension for Work Status	20130607

Events

Interface IF_RSBPCW_WS_DEF has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TN_S_FIELD	Public	See coding			20130607	begin of tn_s_field, iobjnm type rsiobjnm, is_driver type rs_bool, fieldnm type rsfieldnm, end of tn_s_field
2	TN_TS_FIELD	Public	See coding			20130607	tn_ts_field type sorted table of tn_s_field with unique key iobjnm initial size 0
3	TN_TS_VALIDATION_DETAIL	Public	See coding			20130718	begin of tn_ts_validation_detail, code type i, message type string, t_msg type RSBPCW_T_DEF_VALID_DETAIL, end of tn_ts_validation_detail
4	TN_TS_VAL_MSG	Public	See coding			20130718	begin of tn_ts_val_msg, server_code type i, detail type string, end of tn_ts_val_msg
5	TN_TT_VAL_MSG	Public	See coding			20130718	tn_tt_val_msg type standard table of tn_ts_val_msg

Method Signatures

Method GET_COMP_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_COMP_ID	Call by reference	☐	Type reference (TYPE)	RSBPC_COMP_ID	CL_RSBPCW_CONST=>N_C_WS_COMP_ID_PLANNING		20130607
2	Importing	I_STATUS	Call by reference	☐	Type reference (TYPE)	RSBPCW_STATUS			20130607
3	Returning	R_STATE	Value transfer	☐	Type reference (TYPE)	RSBPCW_MODWS			20130607

Method GET_COMP_STATE on Interface IF_RSBPCW_WS_DEF has no exception.

Method GET_DEFAULT_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_COMP_ID	Call by reference	☐	Type reference (TYPE)	RSBPC_COMP_ID	CL_RSBPCW_CONST=>N_C_WS_COMP_ID_PLANNING	BPC IP Extension: Component ID	20130715
2	Returning	R_DEFAULT_STATE	Value transfer	☐	Type reference (TYPE)	RSBPCW_MODWS		BPC: Module Work Status	20130715

Method GET_DEFAULT_STATE on Interface IF_RSBPCW_WS_DEF has no exception.

Method GET_FIELD_MAPPING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_TS_FIELDS_MAP	Call by reference	☐	Type reference (TYPE)	TN_TS_FIELD			20130607

Method GET_FIELD_MAPPING on Interface IF_RSBPCW_WS_DEF has no exception.

Method GET_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_S_WS_DEF	Call by reference	☐	Type reference (TYPE)	RSBPCW_S_WS_DEF			20130607
2	Importing	I_CHECK_DATA_STATUS	Call by reference	☐	Type reference (TYPE)	RS_BOOL	RS_C_FALSE	Check if it contains data	20130607
3	Importing	I_INC_0INFOPROV	Call by reference	☐	Type reference (TYPE)	RS_BOOL	RS_C_TRUE	Inc. 0INFOPROV in Lock Dimensions	20130607
4	Importing	I_READFROMDB	Call by reference	☐	Type reference (TYPE)	RS_BOOL	RS_C_FALSE		20130611

Method GET_INFO on Interface IF_RSBPCW_WS_DEF has no exception.

Method GET_LOCK_METADATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_LASTCHANGE	Call by reference	☐	Type reference (TYPE)	RSTIMESTMP		UTC Time Stamp in Short Form (YYYYMMDDhhmmss)	20130607
2	Exporting	E_LOCK_TAB_NAME	Call by reference	☐	Type reference (TYPE)	TABNAME			20130607
3	Exporting	E_TS_FIELDS_MAP	Call by reference	☐	Type reference (TYPE)	IF_RSPLS_DS_TYPES=>TN_TS_FIELD			20130607
4	Exporting	E_TS_IOBJ	Call by reference	☐	Type reference (TYPE)	IF_RSPLS_DS_TYPES=>TN_TS_IOBJ			20130607
5	Exporting	E_T_INFOPROV	Call by reference	☐	Type reference (TYPE)	RSBPCA_T_INFOPROV			20130617

Method GET_LOCK_METADATA on Interface IF_RSBPCW_WS_DEF has no exception.

Method GET_RUNTIME_MGR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_R_MGR	Value transfer	☐	Object reference (TYPE REF TO)	CL_RSBPCW_RUNTIME_LOCK_MGR			20130607

Method GET_RUNTIME_MGR on Interface IF_RSBPCW_WS_DEF has no exception.

Method GET_SCRIPT_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_S_INFO	Call by reference	☐	Type reference (TYPE)	IF_RSPLS_WS_SQL_SCRIPT_GEN=>TN_S_SQLSCRIPT_OBJECTS			20130723

Method GET_SCRIPT_INFO on Interface IF_RSBPCW_WS_DEF has no exception.

Method GET_WS_DATA_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_TABNAME	Value transfer	☐	Type reference (TYPE)	TABNAME		Table Name	20130607

Method GET_WS_DATA_TABLE on Interface IF_RSBPCW_WS_DEF has no exception.

Method GET_WS_RUNTIME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_R_MGR	Value transfer	☐	Object reference (TYPE REF TO)	IF_RSBPCW_WS_RUNTIME		Work Status Runtime Locks Manager	20130713

Method GET_WS_RUNTIME on Interface IF_RSBPCW_WS_DEF has no exception.

Method SET_EMAIL_CFG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_S_EMAIL_CFG	Call by reference	☐	Type reference (TYPE)	RSBPCW_S_WS_EMAIL_CFG		Work Status Email Configuration	20130725

Method SET_EMAIL_CFG on Interface IF_RSBPCW_WS_DEF has no exception.

Method SET_ENABLE_FLAG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_F_ENABLED	Call by reference	☐	Type reference (TYPE)	RS_BOOL		Boolean	20130705

Method SET_ENABLE_FLAG on Interface IF_RSBPCW_WS_DEF has no exception.

Method SET_LOCK_DIMS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_S_VALIDATION_DETAIL	Call by reference	☐	Type reference (TYPE)	RSBPCW_S_VALIDATION_DETAIL		Work Status Design Time Validation Error	20130718
2	Importing	I_F_ENABLED	Call by reference	☐	Type reference (TYPE)	RS_BOOL	RS_C_TRUE	Boolean	20130705
3	Importing	I_T_LOCK_DIM	Call by reference	☐	Type reference (TYPE)	RSBPCW_T_LCK_DIM		Lock Dimension Table	20130607
4	Importing	I_WITH_INFOPROV	Call by reference	☐	Type reference (TYPE)	RS_BOOL	RS_C_FALSE	Is InfoProvider Specific	20130607

#	Exception	Resumable	Description	Created on
1	CX_RSBPCW_INVALID_INPUT	☐		20130607

Method SET_WORK_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_S_VALIDATION_DETAIL	Call by reference	☐	Type reference (TYPE)	RSBPCW_S_VALIDATION_DETAIL		Work Status Design Time Validation Error	20130718
2	Importing	I_F_ENABLED	Call by reference	☐	Type reference (TYPE)	RS_BOOL	RS_C_TRUE	Boolean	20130705
3	Importing	I_T_WORK_STATE	Call by reference	☐	Type reference (TYPE)	RSBPCW_T_WORK_STATE		Work State Table	20130607

#	Exception	Resumable	Description	Created on
1	CX_RSBPCW_INVALID_INPUT	☐		20130607

Method VALIDATE_DIM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_T_MSG	Call by reference	☐	Type reference (TYPE)	RS_T_MSG			20130612
2	Importing	I_T_LOCK_DIM	Call by reference	☐	Type reference (TYPE)	RSBPCW_T_LCK_DIM			20130607

#	Exception	Resumable	Description	Created on
1	CX_RSBPCW_INVALID_INPUT	☐	BPC IP Extension: Invalid Input	20130716

History

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