SAP ABAP Class /IWFND/CL_METERING_API (API to Metering)

Hierarchy

☛ SAP_GWFND (Software Component) SAP Gateway Foundation
   ⤷ OPU-FND-CS (Application Component) IWF Common Services
     ⤷ /IWFND/COS_MET (Package) GW Framework - Metering

Properties

Class	/IWFND/CL_METERING_API
Short Description	API to Metering
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	/IWFND/COS_MET	GW Framework - Metering
Created	20110311	SAP
Last change	20131127	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
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)

Interfaces

Class /IWFND/CL_METERING_API has no interface implemented.

Friends

Class /IWFND/CL_METERING_API has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_AGG_JOBNAME	Constant	Public	☐	Type reference (TYPE)	TBTCJOB-JOBNAME	'SAP_IWFND_METERING_AGG'	Background job name	20110311
2	GC_AGG_REPORT	Constant	Private	☐	Type reference (TYPE)	SY-REPID	'/IWFND/R_METERING_AGGREGATE'	Report name	20110311
3	GC_APPLIC	Constant	Private	☐	Type reference (TYPE)	RSUVM_APPL	'0370'	ID for an appl. (for example, an IBU) for system measurement	20110526
4	GC_DAILY_PERIOD	Constant	Private	☐	Type reference (TYPE)	TBTCJOB-PRDDAYS	'1'	Duration (in days) of DBA action	20110311
5	GC_DEL_JOBNAME	Constant	Public	☐	Type reference (TYPE)	TBTCJOB-JOBNAME	'SAP_IWFND_METERING_DEL'	Background job name	20110311
6	GC_DEL_REPORT	Constant	Private	☐	Type reference (TYPE)	SY-REPID	'/IWFND/R_METERING_DELETE'	Report name	20110311
7	GC_EXECUTE_AUDIT	Constant	Private	☐	Type reference (TYPE)	STRING	'metering_audit'	Constant for logging	20110408
8	GC_METERING	Static Attribute	Public	☐	Type reference (TYPE)	STRING	'metering'	Constant name for metering	20110329
9	GC_METERING_AGENT	Constant	Public	☐	Type reference (TYPE)	/IWFND/SUP_IW_AGENT	'/IWFND/CL_METERING_API'		20130427
10	GC_SERVICE_CALL_UNIT	Constant	Private	☐	Type reference (TYPE)	RSUVM_UNIT	'0370'	System measurement unit: Number of (ODC) service calls	20121005
11	GC_START_TIME	Constant	Private	☐	Type reference (TYPE)	TBTCJOB-SDLSTRTTM	'030000'	Planned start time for background Job	20110311
12	GC_S_OPERATIONS	Constant	Public	☐	See coding			Operations	20110401
13	GC_USER_UNIT	Constant	Private	☐	Type reference (TYPE)	RSUVM_UNIT	'0372'	System measurement unit: Number of users	20110608
14	GO_METERING_API	Static Attribute	Private	☐	Object reference (TYPE REF TO)	/IWFND/CL_METERING_API		API to Metering	20110329
15	MT_AGG_DATA	Instance attribute	Private	☐	Type reference (TYPE)	/IWFND/T_MET_AGR		obsolete	20121005
16	MV_MSG_HANDLE	Instance attribute	Private	☐	Type reference (TYPE)	BALMSGHNDL		Application Log: Message handle	20110408

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADJUST_PERIOD	Instance method	Public	Method	Adjust period to ensure calendar year	20110627
2	CHECK_ADJUST_JOB	Instance method	Private	Method	Check if a job should be executed and clean up jobs	20130507
3	CHECK_ADJUST_JOB_AGGREGATE	Instance method	Public	Method	Check if a AGGREGATE job should be executed and clean up job	20130507
4	CHECK_ADJUST_JOB_DELETE	Instance method	Public	Method	Check if a DELETE job should be executed and clean up jobs	20130507
5	CHECK_CONTEXT	Instance method	Private	Method	Check retrieved information from context	20110318
6	CREATE_AGGREGATION_JOB	Instance method	Public	Method	Create background job to aggregate metering data	20110311
7	CREATE_DELETION_JOB	Instance method	Public	Method	Create background job to cleanup metering data	20110311
8	CREATE_JOB	Instance method	Private	Method	Create new job	20110311
9	CUMULATE_MONTHLY_CALLS	Instance method	Private	Method	obsolete	20110608
10	CUMULATE_USER	Instance method	Private	Method	Cumulate number of users	20110608
11	DELETE_JOB	Instance method	Private	Method	Delete job	20110311
12	DELETE_SCHEDULED_JOBS	Instance method	Public	Method	Create background job to aggregate metering data	20120417
13	EXECUTE_AUDIT	Instance method	Public	Method	Calculate audit data	20110311
14	GET_METERING_API	Static method	Public	Method	Get instance	20110329
15	GET_NON_AGGREGATED_USAGE_DATA	Instance method	Public	Method	returns metering data which was not aggregated by now	20130427
16	GET_NUMBER_OF_CALLS	Instance method	Private	Method	Cumulate monthly number of calls	20121005
17	REGISTER_NOTIFICATION	Instance method	Public	Method	Collect Metering for Notification	20110328
18	REGISTER_OPERATION	Instance method	Public	Method	Collect metering	20110311
19	SCHEDULE_JOB	Instance method	Private	Method	Scedule job	20110311

Events

Class /IWFND/CL_METERING_API has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_S_MET_EXTRACT_DATA	Public	See coding			20130423	BEGIN OF ty_s_met_extract_data, id TYPE /iwfnd/met_guid, consumer_type TYPE /iwfnd/med_mdl_consumer_type, tech_srv_name TYPE /iwfnd/med_mdl_srg_name, tech_srv_version TYPE /iwfnd/med_mdl_version, operation TYPE /iwfnd/met_operation_type, num_entries TYPE /iwfnd/med_mdl_no_of_entries, entity_type TYPE /iwfnd/med_mdl_external_name, access_type TYPE /iwfnd/met_access_type, format_type TYPE /iwfnd/met_format_type, xml_size TYPE /iwfnd/met_xml_size, namespace TYPE /iwfnd/med_mdl_namespace, END OF ty_s_met_extract_data
2	TY_T_MET_EXTRACT_DATA	Public	See coding			20130423	ty_t_met_extract_data TYPE STANDARD TABLE OF ty_s_met_extract_data WITH DEFAULT KEY

Method Signatures

Method ADJUST_PERIOD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_PERIOD	Call by reference	☐	Type reference (TYPE)	RSUVMPER_T		System Measurement: Table for Periods	20110627

Method ADJUST_PERIOD on class /IWFND/CL_METERING_API has no exception.

Method CHECK_ADJUST_JOB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_REPORT	Call by reference	☐	Type reference (TYPE)	SY-REPID		Report name	20130507
2	Returning	RV_CAN_RUN	Value transfer	☐	Type reference (TYPE)	BOOLE		Boolean variable	20130507

Method CHECK_ADJUST_JOB on class /IWFND/CL_METERING_API has no exception.

Method CHECK_ADJUST_JOB_AGGREGATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_CAN_RUN	Value transfer	☐	Type reference (TYPE)	BOOLE		Boolean variable	20130507

Method CHECK_ADJUST_JOB_AGGREGATE on class /IWFND/CL_METERING_API has no exception.

Method CHECK_ADJUST_JOB_DELETE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_CAN_RUN	Value transfer	☐	Type reference (TYPE)	BOOLE		Boolean variable	20130507

Method CHECK_ADJUST_JOB_DELETE on class /IWFND/CL_METERING_API has no exception.

Method CHECK_CONTEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_DATA	Call by reference	☐	Type reference (TYPE)	/IWFND/S_METERING_COL		Metering Collector (based on DB structure)	20110318

Method CHECK_CONTEXT on class /IWFND/CL_METERING_API has no exception.

Method CREATE_AGGREGATION_JOB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_JOBCOUNT	Value transfer	☐	Type reference (TYPE)	TBTCJOB-JOBCOUNT		Job ID	20110311

#	Exception	Resumable	Description	Created on
1	/IWFND/CX_MET_EXCEPTION	☐	Metering Exception	20110311

Method CREATE_DELETION_JOB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_JOBCOUNT	Value transfer	☐	Type reference (TYPE)	TBTCJOB-JOBCOUNT		Job ID	20110311

#	Exception	Resumable	Description	Created on
1	/IWFND/CX_MET_EXCEPTION	☐	Metering Exception	20110311

Method CREATE_JOB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_JOBNAME	Call by reference	☐	Type reference (TYPE)	TBTCJOB-JOBNAME		Background job name	20110311
2	Importing	IV_PERIOD	Call by reference	☐	Type reference (TYPE)	TBTCJOB-PRDDAYS		Metering Aggregation Period	20110311
3	Importing	IV_REPORT	Call by reference	☐	Type reference (TYPE)	SY-REPID		Report name	20110311
4	Returning	RV_JOBCOUNT	Value transfer	☐	Type reference (TYPE)	TBTCJOB-JOBCOUNT		Job ID	20110311

#	Exception	Resumable	Description	Created on
1	/IWFND/CX_MET_EXCEPTION	☐	Metering Exception	20110311

Method CUMULATE_MONTHLY_CALLS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_RESULT	Call by reference	☐	Type reference (TYPE)	RSUVMRES_T		System Measurement: Table with the Result of Engine Meas.	20110608
2	Importing	IV_BEG_DATE	Call by reference	☐	Type reference (TYPE)	DATS		Begin of period as date	20110608
3	Importing	IV_END_DATE	Call by reference	☐	Type reference (TYPE)	DATS		End of period as date	20110608

Method CUMULATE_MONTHLY_CALLS on class /IWFND/CL_METERING_API has no exception.

Method CUMULATE_USER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_RESULT	Call by reference	☐	Type reference (TYPE)	RSUVMRES_T		System Measurement: Table with the Result of Engine Meas.	20110608
2	Importing	IT_GW_USED	Call by reference	☐	Type reference (TYPE)	/IWFND/T_MET_AGR_GW_USED		Table Type: Metering Usage of Gateway	20110608
3	Importing	IV_BEG_DATE	Call by reference	☐	Type reference (TYPE)	DATS		Begin of period as date	20110608
4	Importing	IV_END_DATE	Call by reference	☐	Type reference (TYPE)	DATS		End of period as date	20110608

Method CUMULATE_USER on class /IWFND/CL_METERING_API has no exception.

Method DELETE_JOB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_JOBCOUNT	Call by reference	☐	Type reference (TYPE)	TBTCJOB-JOBCOUNT		Job ID	20110311
2	Importing	IV_JOBNAME	Call by reference	☐	Type reference (TYPE)	TBTCJOB-JOBNAME		Background job name	20110311

#	Exception	Resumable	Description	Created on
1	/IWFND/CX_MET_EXCEPTION	☐	Metering Exception	20110311

Method DELETE_SCHEDULED_JOBS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_JOBCOUNT	Value transfer	☐	Type reference (TYPE)	TBTCJOB-JOBCOUNT		Job ID	20120417

#	Exception	Resumable	Description	Created on
1	/IWFND/CX_MET_EXCEPTION	☐	Metering Exception	20120417

Method EXECUTE_AUDIT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_RESULT	Call by reference	☐	Type reference (TYPE)	RSUVMRES_T		System Measurement: Table with the Result of Engine Meas.	20110311
2	Importing	IV_BEG_DATE	Call by reference	☐	Type reference (TYPE)	DATS		Field of type DATS	20110311
3	Importing	IV_END_DATE	Call by reference	☐	Type reference (TYPE)	DATS		Field of type DATS	20110311

Method EXECUTE_AUDIT on class /IWFND/CL_METERING_API has no exception.

Method GET_METERING_API Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_METERING_API	Value transfer	☐	Object reference (TYPE REF TO)	/IWFND/CL_METERING_API		API to Metering	20110329

Method GET_METERING_API on class /IWFND/CL_METERING_API has no exception.

Method GET_NON_AGGREGATED_USAGE_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_NON_AGGREGATED_DATA	Call by reference	☐	Type reference (TYPE)	TY_T_MET_EXTRACT_DATA			20130430
2	Exporting	EV_COUNT	Call by reference	☐	Type reference (TYPE)	I			20130430
3	Exporting	EV_NEW_DELTA_TOKEN	Call by reference	☐	Type reference (TYPE)	STRING			20130427
4	Importing	IV_COUNT_ONLY	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL			20130430
5	Importing	IV_DELTA_TOKEN	Call by reference	☑	Type reference (TYPE)	STRING			20130427
6	Importing	IV_KEY	Call by reference	☑	Type reference (TYPE)	/IWFND/MET_GUID			20130430

#	Exception	Resumable	Description	Created on
1	/IWFND/CX_MET_EXCEPTION	☐		20130427

Method GET_NUMBER_OF_CALLS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_RESULT	Call by reference	☐	Type reference (TYPE)	RSUVMRES_T		System Measurement: Table with the Result of Engine Meas.	20121005
2	Importing	IV_BEG_DATE	Call by reference	☐	Type reference (TYPE)	DATS		Begin of period as date	20121005
3	Importing	IV_END_DATE	Call by reference	☐	Type reference (TYPE)	DATS		End of period as date	20121005

Method GET_NUMBER_OF_CALLS on class /IWFND/CL_METERING_API has no exception.

Method REGISTER_NOTIFICATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_DATA	Call by reference	☐	Type reference (TYPE)	/IWFND/T_MET_COL		Metering Data Collector	20110329

Method REGISTER_NOTIFICATION on class /IWFND/CL_METERING_API has no exception.

Method REGISTER_OPERATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_CONTEXT	Call by reference	☑	Object reference (TYPE REF TO)	/IWCOR/IF_REST_CONTEXT		REST Context	20110314
2	Importing	IS_DATA	Call by reference	☑	Type reference (TYPE)	/IWFND/S_METERING_COL		Metering Collector (based on DB structure)	20110328

Method REGISTER_OPERATION on class /IWFND/CL_METERING_API has no exception.

Method SCHEDULE_JOB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_JOBNAME	Call by reference	☐	Type reference (TYPE)	TBTCJOB-JOBNAME		Background job name	20110311
2	Importing	IV_PERIOD	Call by reference	☐	Type reference (TYPE)	TBTCJOB-PRDDAYS		Metering Aggregation Period	20110311
3	Importing	IV_REPORT	Call by reference	☐	Type reference (TYPE)	SY-REPID		Report name	20110311
4	Returning	RV_JOBCOUNT	Value transfer	☐	Type reference (TYPE)	TBTCJOB-JOBCOUNT		Job ID	20110311

#	Exception	Resumable	Description	Created on
1	/IWFND/CX_MET_EXCEPTION	☐	Metering Exception	20110311

History

Last changed by/on	SAP	20131127
SAP Release Created in	250