SAP ABAP Class CL_POWL_QUERY_API (POWL API)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-MUS-POW (Application Component) Personal Object Worklist
     ⤷ GEN_PERSONAL_OBJECT_WORKLIST (Package) generic worklist

Properties

Class	CL_POWL_QUERY_API
Short Description	POWL API
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	GEN_PERSONAL_OBJECT_WORKLIST	generic worklist
Created	20061019	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_POWL_QUERY_API has no forward declaration.

Interfaces

Class CL_POWL_QUERY_API has no interface implemented.

Friends

Class CL_POWL_QUERY_API has no friend class.

Attributes

Class CL_POWL_QUERY_API has no attribute.

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ASSIGN_QUERY_TO_APPLICATION	Static method	Public	Method	Assisgns query to an application/ role or to an user	20080421
2	CREATE_ADMIN_QUERY	Static method	Public	Method	create Admin queries	20070321
3	CREATE_USER_QUERY	Static method	Public	Method	Create an active user query	20090927
4	DELETE_CACHED_RESULTS	Static method	Public	Method	delete query data from database	20090319
5	DELETE_QUERY	Static method	Public	Method	Delete query	20091029
6	GET_APPLID_DESCRIPTION	Static method	Public	Method	Delivers the Application ID description	20100826
7	GET_CATEGORY_DESCRIPTION	Static method	Public	Method	Delivers the admin category description for the user	20100826
8	GET_DEFAULT_QUERY	Static method	Public	Method	Delivers the ID of the Default Query	20100722
9	GET_QUERIES	Static method	Public	Method	return Query Information for given Application ID	20070321
10	GET_QUERY_INFO	Static method	Public	Method	return Queries for given Application ID and powl type	20090927
11	GET_QUERY_PARAMETERS	Static method	Public	Method	return Query parameter	20070321
12	GET_REFRESH_DATA	Static method	Public	Method	return Query refresh result for the given Query ID	20070321
13	GET_VISIBLE_TYPES	Static method	Public	Method	return type information for given Application ID	20080415
14	SET_DEFAULT_QUERY	Static method	Public	Method	Sets the Default Query ID	20100722

Events

Class CL_POWL_QUERY_API has no event.

Types

Class CL_POWL_QUERY_API has no local type.

Method Signatures

Method ASSIGN_QUERY_TO_APPLICATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ACTIVE	Call by reference	☐	Type reference (TYPE)	POWL_ACTIVATION_TY	'X'	Activation	20080422
2	Importing	I_APPLID	Call by reference	☐	Type reference (TYPE)	POWL_APPLID_TY		Application ID	20080422
3	Importing	I_CATEGORY	Call by reference	☑	Type reference (TYPE)	POWL_CATEGORY_TY		Category	20080422
4	Importing	I_CAT_QUERY_SEQ	Call by reference	☑	Type reference (TYPE)	POWL_QUERY_SEQ_TY		sequence number for a query	20080422
5	Importing	I_CAT_SEQUENCE	Call by reference	☑	Type reference (TYPE)	POWL_CAT_SEQ_TY		sequence number for POWL query category	20080422
6	Importing	I_MANDT	Call by reference	☐	Type reference (TYPE)	MANDT	SY-MANDT	Client	20080422
7	Importing	I_QUERY	Call by reference	☐	Type reference (TYPE)	POWL_QUERY_TY		Query ID	20080422
8	Importing	I_REQUEST	Call by reference	☑	Type reference (TYPE)	TRKORR		Request/Task	20080421
9	Importing	I_ROLE	Call by reference	☑	Type reference (TYPE)	AGR_NAME		Role Name	20080422
10	Importing	I_TABS_QUERY_SEQ	Call by reference	☑	Type reference (TYPE)	POWL_TAB_SEQ_TY		sequence number for a query tabstrip	20080422
11	Importing	I_USERNAME	Call by reference	☑	Type reference (TYPE)	XUSER		User name	20080422

Method ASSIGN_QUERY_TO_APPLICATION on class CL_POWL_QUERY_API has no exception.

Method CREATE_ADMIN_QUERY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_DESCRIPTION	Call by reference	☐	Type reference (TYPE)	POWL_QUERYDESCR_TY		Query description	20070321
2	Importing	I_PARAMETERS	Call by reference	☑	Type reference (TYPE)	RSPARAMS_TT		rsparams Table	20070321
3	Importing	I_QUERY	Call by reference	☐	Type reference (TYPE)	POWL_QUERY_TY		Query ID	20070321
4	Importing	I_REQUEST	Call by reference	☑	Type reference (TYPE)	TRKORR		Request/Task	20070321
5	Importing	I_TYPE	Call by reference	☐	Type reference (TYPE)	POWL_TYPE_TY		POWL type ID	20070321

Method CREATE_ADMIN_QUERY on class CL_POWL_QUERY_API has no exception.

Method CREATE_USER_QUERY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ACTIVATE	Call by reference	☐	Type reference (TYPE)	POWL_XFLAG_TY	'X'	X-Flag	20090927
2	Importing	I_ADMIN_QUERY	Call by reference	☐	Type reference (TYPE)	POWL_ADMIN_TY	SPACE	Admin flag	20090927
3	Importing	I_APPLID	Call by reference	☑	Type reference (TYPE)	POWL_APPLID_TY		Application ID	20090927
4	Importing	I_CATEGORY	Call by reference	☑	Type reference (TYPE)	POWL_CATEGORY_TY		Category	20090927
5	Importing	I_CRIT_DEF	Call by reference	☑	Type reference (TYPE)	POWL_SELCRIT_TTY		Selection criteria meta description	20090927
6	Importing	I_CRIT_PARA	Call by reference	☑	Type reference (TYPE)	RSPARAMS_TT		rsparams Table	20090927
7	Importing	I_DEFAULT_PARA	Call by reference	☑	Type reference (TYPE)	RSPARAMS_TT		rsparams Table	20090927
8	Importing	I_DESCRIPTION	Call by reference	☑	Type reference (TYPE)	POWL_QUERYDESCR_TY		Query description	20090927
9	Importing	I_DYN_DATA	Call by reference	☑	Type reference (TYPE)	POWL_DYN_DATA_TTY		POWL dynamic data table	20090927
10	Importing	I_EST_TIME	Call by reference	☑	Type reference (TYPE)	POWL_ESTTIME_TY		Estimated execution time	20090927
11	Importing	I_MASTER_QUERY	Call by reference	☑	Type reference (TYPE)	POWL_QUERY_TY		Query ID	20090927
12	Importing	I_QUERY	Call by reference	☑	Type reference (TYPE)	POWL_QUERY_TY		Query ID	20090927
13	Importing	I_REFRESH_DATE	Call by reference	☑	Type reference (TYPE)	POWL_REFRESHD_TY		Refresh date	20090927
14	Importing	I_REFRESH_TIME	Call by reference	☑	Type reference (TYPE)	POWL_REFRESHT_TY		Refresh time	20090927
15	Importing	I_REFRESH_TYPE	Call by reference	☑	Type reference (TYPE)	POWL_REFRESH_TY		Query Refresh Type	20090927
16	Importing	I_REFRESH_TZONE	Call by reference	☑	Type reference (TYPE)	POWL_REFRESHZ_TY		Refresh time zone	20090927
17	Importing	I_RESULTS	Call by reference	☑	Type reference (TYPE)	POWL_CRESULT_STY		cached results	20090927
18	Importing	I_SYNC_REFRESH	Call by reference	☐	Type reference (TYPE)	POWL_XFLAG_TY	SPACE	X-Flag	20090927
19	Importing	I_TEMP_QUERY	Call by reference	☐	Type reference (TYPE)	POWL_TEMP_TY	SPACE	Temporary query flag	20090927
20	Importing	I_TYPE	Call by reference	☐	Type reference (TYPE)	POWL_TYPE_TY		POWL Type ID	20090927
21	Importing	I_WORKFLOW_RESULT_COUNT	Call by reference	☑	Type reference (TYPE)	POWL_COUNT_TY		entry counter	20090927
22	Returning	R_NEW_QUERY	Value transfer	☐	Type reference (TYPE)	POWL_QUERY_STY		query definitions	20090927

Method CREATE_USER_QUERY on class CL_POWL_QUERY_API has no exception.

Method DELETE_CACHED_RESULTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_QUERY	Call by reference	☐	Type reference (TYPE)	POWL_QUERY_STY		query definitions	20090319

Method DELETE_CACHED_RESULTS on class CL_POWL_QUERY_API has no exception.

Method DELETE_QUERY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_QUERY	Call by reference	☐	Type reference (TYPE)	POWL_QUERY_STY		query definitions	20091029

Method DELETE_QUERY on class CL_POWL_QUERY_API has no exception.

Method GET_APPLID_DESCRIPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_APPLID	Call by reference	☐	Type reference (TYPE)	POWL_APPLID_TY		Application ID	20100826
2	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	STRING			20100826

Method GET_APPLID_DESCRIPTION on class CL_POWL_QUERY_API has no exception.

Method GET_CATEGORY_DESCRIPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_APPLID	Call by reference	☐	Type reference (TYPE)	POWL_APPLID_TY		Application ID	20100826
2	Importing	I_CATEGORY_ID	Call by reference	☐	Type reference (TYPE)	POWL_CATEGORY_TY		Category	20100826
3	Importing	I_USER	Call by reference	☐	Type reference (TYPE)	XUSER		User name	20100826
4	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	POWL_CATDESCR_TY		Category description	20100826

Method GET_CATEGORY_DESCRIPTION on class CL_POWL_QUERY_API has no exception.

Method GET_DEFAULT_QUERY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	M_APPLID	Call by reference	☐	Type reference (TYPE)	POWL_APPLID_TY		Application ID	20100728
2	Returning	M_RESULT	Value transfer	☐	Type reference (TYPE)	POWL_QUERY_TY		Query ID	20100728
3	Importing	M_USER	Call by reference	☐	Type reference (TYPE)	XUSER		User name	20100728

#	Exception	Resumable	Description	Created on
1	CX_QUERY_ACCESS_ERROR	☐	error when accessing query on database	20100722

Method GET_QUERIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_APPLID	Call by reference	☐	Type reference (TYPE)	POWL_APPLID_TY		Application ID	20070321
2	Importing	I_USER	Call by reference	☐	Type reference (TYPE)	XUSER		User name	20070321
3	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	POWL_QUERY_ATTY		query infos	20070321

Method GET_QUERIES on class CL_POWL_QUERY_API has no exception.

Method GET_QUERY_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_APPLID	Call by reference	☐	Type reference (TYPE)	POWL_APPLID_TY		Application ID	20090927
2	Importing	I_POWL_TYPE	Call by reference	☐	Type reference (TYPE)	POWL_TYPE_TY		POWL Type ID	20090927
3	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	POWL_QUERY_ATTY		POWL Query API	20090927

Method GET_QUERY_INFO on class CL_POWL_QUERY_API has no exception.

Method GET_QUERY_PARAMETERS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_QUERY	Call by reference	☐	Type reference (TYPE)	POWL_QUERY_TY		query ID	20070321
2	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	RSPARAMS_TT		ABAP: General Structure for PARAMETERS and SELECT-OPTIONS	20070321

Method GET_QUERY_PARAMETERS on class CL_POWL_QUERY_API has no exception.

Method GET_REFRESH_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_FIELDCAT	Call by reference	☐	Type reference (TYPE)	POWL_FIELDCAT_TTY		Field catalog META description	20070321
2	Exporting	E_MESSAGES	Call by reference	☐	Type reference (TYPE)	POWL_MSG_TTY		Message META description	20070321
3	Exporting	E_REFRESH_DATE	Call by reference	☐	Type reference (TYPE)	POWL_REFRESHD_TY		Refresh date	20090927
4	Exporting	E_REFRESH_TIME	Call by reference	☐	Type reference (TYPE)	POWL_REFRESHT_TY		Refresh time	20090927
5	Exporting	E_REFRESH_TZONE	Call by reference	☐	Type reference (TYPE)	POWL_REFRESHZ_TY		Refresh time zone	20090927
6	Exporting	E_RESULT	Value transfer	☐	Object reference (TYPE REF TO)	DATA		Refresh Result	20070321
7	Importing	I_DO_REFRESH	Call by reference	☑	Type reference (TYPE)	POWL_XFLAG_TY		X-Flag	20070321
8	Importing	I_QUERY	Call by reference	☐	Type reference (TYPE)	POWL_QUERY_ASTY		Query ID	20070321

#	Exception	Resumable	Description	Created on
1	CX_QUERY_ACCESS_ERROR	☐	error when accessing query on database	20101126

Method GET_VISIBLE_TYPES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_APPLID	Call by reference	☐	Type reference (TYPE)	POWL_APPLID_TY		Application ID	20080415
2	Importing	I_LANGU	Call by reference	☐	Type reference (TYPE)	LANG		Language ID	20080415
3	Importing	I_USERNAME	Call by reference	☐	Type reference (TYPE)	XUSER		User name	20080415
4	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	POWL_TYPE_TTY		Type definitions	20080415

Method GET_VISIBLE_TYPES on class CL_POWL_QUERY_API has no exception.

Method SET_DEFAULT_QUERY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	M_APPLID	Call by reference	☐	Type reference (TYPE)	POWL_APPLID_TY		Application ID	20100728
2	Importing	M_QUERY	Call by reference	☐	Type reference (TYPE)	POWL_QUERY_TY		Query ID	20100728
3	Importing	M_USER	Call by reference	☐	Type reference (TYPE)	XUSER		User name	20100728

#	Exception	Resumable	Description	Created on
1	CX_QUERY_ACCESS_ERROR	☐	error when accessing query on database	20100728

History

Last changed by/on	SAP	20130531
SAP Release Created in	703