SAP ABAP Interface IF_CLS_REPORT_RUN (Interface for report run)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-DWB-UTL-CLS (Application Component) Classification Toolset
     ⤷ SPAK_API_CLASSIFICATION (Package) API for Classification Tool Set

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	CL_CLS_REPORT_RUN	Report run	20051012

Properties

Interface	IF_CLS_REPORT_RUN
Short Description	Interface for report run

General Data

Package	SPAK_API_CLASSIFICATION	API for Classification Tool Set
Created	20051012	SAP
Last changed	20110908	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_CLS_OBJECT_CHARACTERIZATION	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

Interface IF_CLS_REPORT_RUN has no interface.

Friends

Interface IF_CLS_REPORT_RUN has no friend.

Attributes

Interface IF_CLS_REPORT_RUN has no attribute.

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_OBJECT_LIST_IS_NOT_EMPTY	Instance method	Public	Method	Run result: Is the object list emtpy?	20051209
2	CHECK_PERMISSION_TO_EXECUTE	Instance method	Public	Method		20061005
3	CLONE	Instance method	Public	Method	Create a new run with the same parameters	20061102
4	EXECUTE	Instance method	Public	Method	Execute report run	20051012
5	GET_COLLECTOR	Instance method	Public	Method	Get collector	20051012
6	GET_COUNTERS	Instance method	Public	Method	Run result: Get counters for matching objects	20051027
7	GET_DISTRIBUTION	Instance method	Public	Method	Run result: Get distribution of attribute values	20051027
8	GET_EXPIRATION_DATE	Instance method	Public	Method	Get expiration date	20051012
9	GET_FILTER	Instance method	Public	Method	Get object filter	20051012
10	GET_NAME	Instance method	Public	Method	Get report name	20051012
11	GET_OBJECTS	Instance method	Public	Method	Run result: Get list of matching objects	20051027
12	GET_REPORT_DEF	Instance method	Public	Method	Get reference of report definition	20051012
13	GET_RESULT	Instance method	Public	Method	Get trun result	20100128
14	GET_STATE	Instance method	Public	Method	Get state of report (created, running, finished,...)	20051012
15	GET_VERSION	Instance method	Public	Method	Get version of the report	20051012
16	SAVE	Instance method	Public	Method	Save run	20051014
17	SAVE_STATE	Instance method	Public	Method	Save header data of run	20051214
18	SET_BATCH_ID	Instance method	Public	Method	Set process id	20051214
19	SET_EXPIRATION_DATE	Instance method	Public	Method	Set expiration date	20051012
20	SET_FILTER	Instance method	Public	Method	Set object filter	20051012
21	SET_STATE	Instance method	Public	Method	Set state of report (created, running, finished,...)	20051209

Events

Interface IF_CLS_REPORT_RUN has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_COMPONENT_RANGE	Public	See coding			20051013	ty_component_range type range of ufps_posid
2	TY_DLVUNIT_RANGE	Public	See coding			20051013	ty_dlvunit_range type range of dlvunit
3	TY_OBJ_NAME_RANGE	Public	See coding			20051013	ty_obj_name_range type range of tadir-obj_name
4	TY_PACKAGE_RANGE	Public	See coding			20051013	ty_package_range type range of devclass
5	TY_PROJECT_ID_RANGE	Public	See coding			20051013	ty_project_id_range type range of pak_project_id
6	TY_SRCSYSTEM_RANGE	Public	See coding			20051013	ty_srcsystem_range type range of tadir-srcsystem
7	TY_TRANSPORT_LAYER_RANGE	Public	See coding			20060120	ty_transport_layer_range type range of tdevc-pdevclass
8	TY_TYPE_LIST	Public	See coding			20051013	ty_type_list type sorted table of cls_object_type_group with unique key table_line
9	TY_USER_RANGE	Public	See coding			20051013	ty_user_range type range of author

Method Signatures

Method CHECK_OBJECT_LIST_IS_NOT_EMPTY Signature

Method CHECK_OBJECT_LIST_IS_NOT_EMPTY on Interface IF_CLS_REPORT_RUN has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_CLS_INVALID_REPORT_DATA	☐		20051209

Method CHECK_PERMISSION_TO_EXECUTE Signature

Method CHECK_PERMISSION_TO_EXECUTE on Interface IF_CLS_REPORT_RUN has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_PAK_NOT_AUTHORIZED	☐	User doesn't have sufficient authorizations	20061005

Method CLONE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_CLONE	Value transfer	☐	Object reference (TYPE REF TO)	IF_CLS_REPORT_RUN		Interface for report run	20061102

#	Exception	Resumable	Description	Created on
1	CX_PAK_INVALID_DATA	☐	Invalid data	20061102
2	CX_PAK_NOT_AUTHORIZED	☐	User doesn't have sufficient authorizations	20061102

Method EXECUTE Signature

Method EXECUTE on Interface IF_CLS_REPORT_RUN has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_PAK_GUI_ERROR	☐	GUI Package-Builder exceptions	20051111
2	CX_PAK_INVALID_DATA	☐	Operation can't be executed in present object state	20051017
3	CX_PAK_INVALID_STATE	☐		20051111
4	CX_PAK_NOT_AUTHORIZED	☐	User doesn't have sufficient authorizations	20051027

Method GET_COLLECTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_COLLECTOR	Value transfer	☐	Object reference (TYPE REF TO)	CL_CLS_OBJECT_COLLECTOR		Object collector	20051027

#	Exception	Resumable	Description	Created on
1	CX_PAK_INVALID_DATA	☐	Operation can't be executed in present object state	20051017

Method GET_COUNTERS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_COUNTERS	Call by reference	☐	Type reference (TYPE)	CLS_RUN_COUNTERS_TAB		Table type of CLS_RUN_COUNTERS	20051027

#	Exception	Resumable	Description	Created on
1	CX_CLS_INVALID_STATE	☐		20051027

Method GET_DISTRIBUTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_DISTRIBUTION	Call by reference	☐	Type reference (TYPE)	CLS_RUN_DISTR_TAB		Table type of CLS_RUN_DISTR	20051027

#	Exception	Resumable	Description	Created on
1	CX_CLS_INVALID_STATE	☐		20051027

Method GET_EXPIRATION_DATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_EXPIRATION_DATE	Value transfer	☐	Type reference (TYPE)	DATS		Field of type DATS	20051012

#	Exception	Resumable	Description	Created on
1	CX_PAK_INVALID_DATA	☐	Operation can't be executed in present object state	20051017

Method GET_FILTER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_COMPONENT_FILTER	Call by reference	☐	Type reference (TYPE)	TY_COMPONENT_RANGE			20051027
2	Exporting	EX_DLVUNIT_FILTER	Call by reference	☐	Type reference (TYPE)	TY_DLVUNIT_RANGE			20051027
3	Exporting	EX_HOME_PACKAGES	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20051027
4	Exporting	EX_LOCAL_PACKAGES	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20051027
5	Exporting	EX_OBJECTS	Call by reference	☐	Type reference (TYPE)	PAK_OBJECT_LIST		List of development objects	20051027
6	Exporting	EX_OBJ_NAME_FILTER	Call by reference	☐	Type reference (TYPE)	TY_OBJ_NAME_RANGE			20051027
7	Exporting	EX_PACKAGE_FILTER	Call by reference	☐	Type reference (TYPE)	TY_PACKAGE_RANGE			20051027
8	Exporting	EX_PROJECT_ID_FILTER	Call by reference	☐	Type reference (TYPE)	TY_PROJECT_ID_RANGE			20051027
9	Exporting	EX_SRCSYSTEM_FILTER	Call by reference	☐	Type reference (TYPE)	TY_SRCSYSTEM_RANGE			20051027
10	Exporting	EX_TRANSPORTABLE_PACKAGES	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20051027
11	Exporting	EX_TRANSPORT_LAYER_FILTER	Call by reference	☐	Type reference (TYPE)	TY_TRANSPORT_LAYER_RANGE			20060120
12	Exporting	EX_TYPE_FILTER	Call by reference	☐	Type reference (TYPE)	TY_TYPE_LIST			20051027
13	Exporting	EX_USER_FILTER	Call by reference	☐	Type reference (TYPE)	TY_USER_RANGE			20051027

#	Exception	Resumable	Description	Created on
1	CX_PAK_INVALID_DATA	☐	Operation can't be executed in present object state	20051017

Method GET_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_NAME	Value transfer	☐	Type reference (TYPE)	CLS_REPORT_DEF_NAME		Name of report definition	20051012

#	Exception	Resumable	Description	Created on
1	CX_PAK_INVALID_DATA	☐	Operation can't be executed in present object state	20051017

Method GET_OBJECTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_OBJECTS	Call by reference	☐	Type reference (TYPE)	PAK_OBJECT_LIST		List of development objects	20051027

Method GET_OBJECTS on Interface IF_CLS_REPORT_RUN has no exception.

Method GET_REPORT_DEF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_DEF	Value transfer	☐	Object reference (TYPE REF TO)	IF_CLS_REPORT_DEF		definition of calssificationsreport	20051027

#	Exception	Resumable	Description	Created on
1	CX_PAK_INVALID_DATA	☐	Operation can't be executed in present object state	20051017

Method GET_RESULT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_RUN_RESULT	Value transfer	☐	Object reference (TYPE REF TO)	CL_CLS_REPORT_RUN_RESULT		Container for objects and classifications	20100128

#	Exception	Resumable	Description	Created on
1	CX_PAK_INVALID_DATA	☐	Invalid data	20100128
2	CX_PAK_INVALID_STATE	☐	Operation can't be executed in present object state	20100128
3	CX_PAK_NOT_AUTHORIZED	☐	User doesn't have sufficient authorizations	20100128

Method GET_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_STATE	Value transfer	☐	Type reference (TYPE)	CLS_RUN_STATE		State of a report run	20051012

#	Exception	Resumable	Description	Created on
1	CX_PAK_INVALID_DATA	☐	Operation can't be executed in present object state	20051017

Method GET_VERSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_VERSION	Value transfer	☐	Type reference (TYPE)	CLS_RUN_VERSION		Version of a report run	20051012

#	Exception	Resumable	Description	Created on
1	CX_PAK_INVALID_DATA	☐	Operation can't be executed in present object state	20051017

Method SAVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_DEVCLASS	Call by reference	☑	Type reference (TYPE)	DEVCLASS		Package	20100128
2	Importing	IM_UPDATE_METHOD_INSERT	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20051117

#	Exception	Resumable	Description	Created on
1	CX_PAK_INVALID_DATA	☐	Invalid data	20051017

Method SAVE_STATE Signature

Method SAVE_STATE on Interface IF_CLS_REPORT_RUN has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_PAK_INVALID_DATA	☐	Invalid data	20051214

Method SET_BATCH_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_BATCH_ID	Call by reference	☑	Type reference (TYPE)	BTCJOBCNT		Date of Last Change	20051214

Method SET_BATCH_ID on Interface IF_CLS_REPORT_RUN has no exception.

Method SET_EXPIRATION_DATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_EXPIRATION_DATE	Call by reference	☐	Type reference (TYPE)	AS4DATE		Date of Last Change	20051027

Method SET_EXPIRATION_DATE on Interface IF_CLS_REPORT_RUN has no exception.

Method SET_FILTER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_COMPONENT_FILTER	Call by reference	☑	Type reference (TYPE)	TY_COMPONENT_RANGE			20051013
2	Importing	IM_DLVUNIT_FILTER	Call by reference	☑	Type reference (TYPE)	TY_DLVUNIT_RANGE			20051013
3	Importing	IM_HOME_PACKAGES	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL			20051013
4	Importing	IM_LOCAL_PACKAGES	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL			20051013
5	Importing	IM_OBJECTS	Call by reference	☑	Type reference (TYPE)	PAK_OBJECT_LIST		List of development objects	20051013
6	Importing	IM_OBJ_NAME_FILTER	Call by reference	☑	Type reference (TYPE)	TY_OBJ_NAME_RANGE			20051013
7	Importing	IM_PACKAGE_FILTER	Call by reference	☑	Type reference (TYPE)	TY_PACKAGE_RANGE			20051013
8	Importing	IM_PROJECT_ID_FILTER	Call by reference	☑	Type reference (TYPE)	TY_PROJECT_ID_RANGE			20051013
9	Importing	IM_SRCSYSTEM_FILTER	Call by reference	☑	Type reference (TYPE)	TY_SRCSYSTEM_RANGE			20051013
10	Importing	IM_TRANSPORTABLE_PACKAGES	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL			20051013
11	Importing	IM_TRANSPORT_LAYER_FILTER	Call by reference	☑	Type reference (TYPE)	TY_TRANSPORT_LAYER_RANGE			20060120
12	Importing	IM_TYPE_FILTER	Call by reference	☑	Type reference (TYPE)	TY_TYPE_LIST			20051013
13	Importing	IM_USER_FILTER	Call by reference	☑	Type reference (TYPE)	TY_USER_RANGE			20051013

Method SET_FILTER on Interface IF_CLS_REPORT_RUN has no exception.

Method SET_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_STATE	Call by reference	☐	Type reference (TYPE)	CLS_RUN_STATE		Date of Last Change	20051209

Method SET_STATE on Interface IF_CLS_REPORT_RUN has no exception.

History

Last changed by/on	SAP	20110908
SAP Release Created in	710