SAP ABAP Class CL_APC_WS_PROGRESS_INDICATOR (ABAP Push Channel progress indicator)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-MID-AC (Application Component) ABAP Channels
     ⤷ SAPC_APPLICATION (Package) APC application package

Properties

Class	CL_APC_WS_PROGRESS_INDICATOR
Short Description	ABAP Push Channel progress indicator
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status
Category	0
Package	SAPC_APPLICATION	APC application package
Created	20130418	SAP
Last change	20140121	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 CL_APC_WS_PROGRESS_INDICATOR has no interface implemented.

Friends

Class CL_APC_WS_PROGRESS_INDICATOR has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CO_DISABLE	Constant	Public	☐	Type reference (TYPE)	C	ABAP_FALSE	Enable the initiated action	20130418
2	CO_ENABLE	Constant	Public	☐	Type reference (TYPE)	C	ABAP_TRUE	Enable the initiated action	20130418
3	CO_PROGRESS_INDICATOR	Constant	Private	☐	Type reference (TYPE)	AMC_CHANNEL_ID	'/progress_indicator'	Identifier of the ABAP Messaging Channel	20130511
4	CO_SYSTEM_CHANNELS	Constant	Private	☐	Type reference (TYPE)	AMC_APPLICATION_ID	'SYSTEM_CHANNELS'	ABAP Messaging Application identifier	20130511
5	CO_WEBGUI_CHANNEL_EXTENSION_ID	Static Attribute	Private	☐	Type reference (TYPE)	STRING	',ext_id='	WebGUI channel extension ID	20131120
6	GO_PCP	Static Attribute	Private	☐	Object reference (TYPE REF TO)	IF_AC_MESSAGE_TYPE_PCP		ABAP Channels message type Push Channel Protocol (PCP)	20130614
7	GO_PRODUCER	Static Attribute	Private	☐	Object reference (TYPE REF TO)	IF_AMC_MESSAGE_PRODUCER_PCP		AMC producer for Push Channel Protocol (PCP) messages	20130614
8	G_IS_ITS_PLUGIN_SESSION	Static Attribute	Private	☐	Type reference (TYPE)	ANSWER		Alternative reply for dialog query	20130930
9	G_PREPARE_WINDOW_ID	Static Attribute	Private	☐	Type reference (TYPE)	GTYPE_WINDOW_ID			20130619
10	G_WINDOW_REGISTRATION	Static Attribute	Private	☐	Type reference (TYPE)	GTYPE_WINDOW_REGISTRATION			20130619
11	M_PROGRESS_INDICATOR_STATE	Static Attribute	Public	☑	Type reference (TYPE)	C		SAPGUI progress indicator state	20130418

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ACTIVATE	Instance method	Public	Method	Activate SAPGUI progress indicator in HTTP contex	20130619
2	DEACTIVATE	Instance method	Public	Method	Deactivate SAPGUI progress indicator in HTTP contex	20130619
3	GET	Static method	Public	Method	Create or get an instance of progress indicator	20130619
4	PREPARE	Static method	Public	Method	Bind AMC channel to SAPGUI progress indicator in APC service	20130619
5	SEND	Instance method	Public	Method	Send SAPGUI progress indicator information	20130619

Events

Class CL_APC_WS_PROGRESS_INDICATOR has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	GTYPE_WINDOW_ID	Public	See coding			20130511	gtype_window_id TYPE c LENGTH 32
2	GTYPE_WINDOW_REGISTRATION	Private	See coding			20130619	BEGIN OF gtype_window_registration, window_id_field_name TYPE string, window_id TYPE gtype_window_id, progress_indicator TYPE REF TO cl_apc_ws_progress_indicator, END OF gtype_window_registration

Method Signatures

Method ACTIVATE Signature

Method ACTIVATE on class CL_APC_WS_PROGRESS_INDICATOR has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_APC_WS_PROGRESS_INDICATOR	☐	APC WS progress indicator error class	20130619

Method DEACTIVATE Signature

Method DEACTIVATE on class CL_APC_WS_PROGRESS_INDICATOR has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_APC_WS_PROGRESS_INDICATOR	☐	APC WS progress indicator error class	20130619

Method GET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CHECK_RECEIVER	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Check the availability of APC WebSocket receiver	20130826
2	Importing	I_WINDOW_ID	Call by reference	☐	Type reference (TYPE)	GTYPE_WINDOW_ID			20130619
3	Importing	I_WINDOW_ID_FIELD_NAME	Call by reference	☐	Type reference (TYPE)	STRING	'WINDOW_ID'	PCP field name	20130710
4	Returning	R_PROGRESSS_INDICATOR	Value transfer	☐	Object reference (TYPE REF TO)	CL_APC_WS_PROGRESS_INDICATOR		ABAP Push Channel progress indicator	20130619

#	Exception	Resumable	Description	Created on
1	CX_APC_WS_PROGRESS_INDICATOR	☐	APC WS progress indicator exception class	20130619

Method PREPARE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_BINDING_MANAGER	Call by reference	☐	Object reference (TYPE REF TO)	IF_APC_WS_BINDING_MANAGER		APC framework: Connection binding manager (do not implement)	20130619
2	Importing	I_WINDOW_ID	Call by reference	☐	Type reference (TYPE)	GTYPE_WINDOW_ID			20130619

#	Exception	Resumable	Description	Created on
1	CX_APC_WS_PROGRESS_INDICATOR	☐	APC WS progress indicator exception class	20130619

Method SEND Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_PERCENTAGE	Call by reference	☐	Type reference (TYPE)	I			20130619
2	Importing	I_TEXT	Call by reference	☐	Type reference (TYPE)	C			20130619

#	Exception	Resumable	Description	Created on
1	CX_APC_WS_PROGRESS_INDICATOR	☐	APC WS progress indicator exception class	20130619

History

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