SAP ABAP Class CL_BCB_CONTAINER (BCB Container)

Hierarchy

☛ WEBCUIF (Software Component) SAP Web UI Framework
   ⤷ CA-GTF-IC-CHA (Application Component) Communication Channel
     ⤷ ICI_BCB (Package) Business Communication Broker

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_BCB_EVENT_SINK	ICI Event Sink	20031113
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_BCB_CONTAINER	BCB Container Interface	20031113
3	Interface implementation (CLASS c. INTERFACES i_ref)	IF_BCB_CONTAINER_CONSTANTS	BCB Container Constants	20031113
4	Interface implementation (CLASS c. INTERFACES i_ref)	IF_BCB_CONTAINER_PROPS_ACCESS	BCB Container Properties Access	20031125

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_BCB_ACTIONI_FOLDER		20060322
2	Inheritance (c INHERITING FROM c_ref)	CL_BCB_CHAT_LINE	BCB Chat Line	20031113
3	Inheritance (c INHERITING FROM c_ref)	CL_BCB_FOLDER	BCB Folder	20031113
4	Inheritance (c INHERITING FROM c_ref)	CL_BCB_PHONE_LINE	BCB Phone Line	20031113

Properties

Class	CL_BCB_CONTAINER
Short Description	BCB Container
Super Class	CL_BCB_EVENT_SINK	ICI Event Sink
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	ICI_BCB	Business Communication Broker
Created	20031113	SAP
Last change	20081007	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)
2	BCB	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
3	CICI	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_BCB_CONTAINER	☐	☐	BCB Container Interface	20031113
2	IF_BCB_CONTAINER_CONSTANTS	☐	☐	BCB Container Constants	20031113
3	IF_BCB_CONTAINER_PROPS_ACCESS	☐	☐	BCB Container Properties Access	20031125

Friends

#	Friend	Modeled only	Created on	Description
1	CL_BCB_ITEM	☐	20031120	BCB Item

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	M_CHANNEL	Instance attribute	Public	☐	Attribute reference (LIKE)				20031114
2	M_ICI_CONTAINER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_ICI_CONTAINER		ICI Container	20031117
3	M_ID	Instance attribute	Protected	☐	Type reference (TYPE)	STRING		Container ID	20031113
4	M_ITEMS	Instance attribute	Protected	☐	Type reference (TYPE)	BCB_ITEM_REF_T		Table of Item References	20031113
5	M_ITEMS_UP_TO_DATE	Instance attribute	Protected	☐	Type reference (TYPE)	ABAP_BOOL		All Items up-to-date?	20031113
6	M_SESSION	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_BCB_SESSION		Session	20031113
7	M_STATUS	Instance attribute	Protected	☐	Type reference (TYPE)	BCB_TEXT_ELEMENT		Container Status	20031113
8	STATUS_FAILURE	Instance attribute	Public	☐	Attribute reference (LIKE)				20031113
9	STATUS_OK	Instance attribute	Public	☐	Attribute reference (LIKE)				20031113
10	STATUS_REMOVED	Instance attribute	Public	☐	Attribute reference (LIKE)				20031113

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_ITEM	Instance method	Public	Method		20031127
2	CHECK_STATUS	Static method	Public	Method	Check Container Status	20031113
3	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20031113
4	CONTAINS_ITEM	Instance method	Public	Method	Container contains a named item?	20031113
5	DELETE_ITEM	Instance method	Public	Method		20031212
6	FIRE_ITEM_CHANGED_EVENT	Instance method	Protected	Method	Notify application about changed item from within container	20031211
7	FIRE_ITEM_DELETED_EVENT	Instance method	Protected	Method	Notify application about deleted item from within container	20031211
8	FIRE_ITEM_NEW_EVENT	Instance method	Protected	Method	Notify application about new item from within container	20031211
9	GET_CHANNEL	Instance method	Public	Method		20031114
10	GET_ID	Instance method	Public	Method	Get Container ID	20031113
11	GET_ITEM	Instance method	Public	Method		20031212
12	GET_ITEMS	Instance method	Public	Method		20031114
13	GET_STATUS	Instance method	Public	Method	Get Container Status	20031113
14	ON_CHANGED	Instance method	Protected	Event handling method	Receive container change notification (inbound)	20031120
15	ON_SUBSCRIPTION_ENDED	Instance method	Protected	Event handling method	Receive end of subscription notification (inbound)	20031120
16	REGISTER	Instance method	Public	Method	Register Application Event Sink and start notifications	20031205
17	SUBSCRIBE	Instance method	Protected	Method	Subcribe to ICI events	20031117
18	UNREGISTER	Instance method	Public	Method	Unregister Application Event Sink and stop notifications	20031205
19	UNSUBSCRIBE	Instance method	Protected	Method	Unsubcribe to ICI events	20031117

Events

#	Event	Type	Visibility	Description	Created on
1	CONTAINER_CHANGED	Instance Event (0)	Public (2)	Container Changed	20031113
2	CONTAINER_DELETED	Instance Event (0)	Public (2)	Container Deleted	20031113
3	ITEM_CHANGED	Instance Event (0)	Public (2)	Item Changed in Container	20031113
4	ITEM_DELETED	Instance Event (0)	Public (2)	Item Deleted in Container	20031113
5	ITEM_NEW	Instance Event (0)	Public (2)	New Item in Container	20031113
6	SUBSCRIPTION_ENDED	Instance Event (0)	Public (2)	Subscription Ended	20031113

Types

Class CL_BCB_CONTAINER has no local type.

Method Signatures

Method ADD_ITEM Signature

Method ADD_ITEM on class CL_BCB_CONTAINER has no parameter.
Method ADD_ITEM on class CL_BCB_CONTAINER has no exception.

Method CHECK_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	STATUS	Call by reference	☐	Type reference (TYPE)	STRING		Status to be checked	20031113

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐	BCB Fehler aufgetreten	20031113

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID	Value transfer	☐	Type reference (TYPE)	STRING		Behälter-ID	20031113
2	Importing	SESSION	Value transfer	☐	Object reference (TYPE REF TO)	CL_BCB_SESSION		BCB Session	20031113

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐	BCB Fehler aufgetreten	20031113

Method CONTAINS_ITEM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID	Value transfer	☐	Type reference (TYPE)	STRING		Item ID to search for	20031113
2	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		Container contains the named item?	20031113

Method CONTAINS_ITEM on class CL_BCB_CONTAINER has no exception.

Method DELETE_ITEM Signature

Method DELETE_ITEM on class CL_BCB_CONTAINER has no parameter.
Method DELETE_ITEM on class CL_BCB_CONTAINER has no exception.

Method FIRE_ITEM_CHANGED_EVENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ITEM	Call by reference	☐	Object reference (TYPE REF TO)	CL_BCB_ITEM		BCB Item	20031211
2	Importing	ITEM_CHANGES	Call by reference	☐	Object reference (TYPE REF TO)	CL_BCB_ITEM_CHANGES		BCB Item Changes	20031211

Method FIRE_ITEM_CHANGED_EVENT on class CL_BCB_CONTAINER has no exception.

Method FIRE_ITEM_DELETED_EVENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ITEM	Call by reference	☐	Object reference (TYPE REF TO)	CL_BCB_ITEM		BCB Item	20031211
2	Importing	ITEM_CHANGES	Call by reference	☐	Object reference (TYPE REF TO)	CL_BCB_ITEM_CHANGES		BCB Item Changes	20031211

Method FIRE_ITEM_DELETED_EVENT on class CL_BCB_CONTAINER has no exception.

Method FIRE_ITEM_NEW_EVENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ITEM	Call by reference	☐	Object reference (TYPE REF TO)	CL_BCB_ITEM		BCB Item	20031211

Method FIRE_ITEM_NEW_EVENT on class CL_BCB_CONTAINER has no exception.

Method GET_CHANNEL Signature

Method GET_CHANNEL on class CL_BCB_CONTAINER has no parameter.
Method GET_CHANNEL on class CL_BCB_CONTAINER has no exception.

Method GET_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ID	Value transfer	☐	Type reference (TYPE)	STRING		Behälter-ID	20031113

Method GET_ID on class CL_BCB_CONTAINER has no exception.

Method GET_ITEM Signature

Method GET_ITEM on class CL_BCB_CONTAINER has no parameter.
Method GET_ITEM on class CL_BCB_CONTAINER has no exception.

Method GET_ITEMS Signature

Method GET_ITEMS on class CL_BCB_CONTAINER has no parameter.
Method GET_ITEMS on class CL_BCB_CONTAINER has no exception.

Method GET_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	STATUS	Value transfer	☐	Type reference (TYPE)	BCB_TEXT_ELEMENT		Container Status	20031113

Method GET_STATUS on class CL_BCB_CONTAINER has no exception.

Method ON_CHANGED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	APPLICATION_ID	Call by reference	☐	Attribute reference (LIKE)				20031120
2	Importing	CHANNEL	Call by reference	☐	Attribute reference (LIKE)				20031120
3	Importing	ID	Call by reference	☐	Attribute reference (LIKE)				20031120
4	Importing	STATUS	Call by reference	☐	Attribute reference (LIKE)				20031120

Method ON_CHANGED on class CL_BCB_CONTAINER has no exception.

Method ON_SUBSCRIPTION_ENDED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	APPLICATION_ID	Call by reference	☐	Attribute reference (LIKE)				20031120
2	Importing	REASON	Call by reference	☐	Attribute reference (LIKE)				20031120

Method ON_SUBSCRIPTION_ENDED on class CL_BCB_CONTAINER has no exception.

Method REGISTER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	APPLICATION_EVENT_SINK	Value transfer	☐	Object reference (TYPE REF TO)	IF_BCB_CONTAINER_EVENT_SINK		Interface für Änderungen an BCB User	20031205

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐		20031205

Method SUBSCRIBE Signature

Method SUBSCRIBE on class CL_BCB_CONTAINER has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐	BCB Fehler aufgetreten	20031117

Method UNREGISTER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	APPLICATION_EVENT_SINK	Value transfer	☐	Object reference (TYPE REF TO)	IF_BCB_CONTAINER_EVENT_SINK		Interface für Änderungen an BCB User	20031205

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐	BCB Fehler aufgetreten	20040510

Method UNSUBSCRIBE Signature

Method UNSUBSCRIBE on class CL_BCB_CONTAINER has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_BCB_EXCEPTION	☐	BCB Fehler aufgetreten	20031117

Event Signatures

Event CONTAINER_CHANGED Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	CONTAINER	Exporting	Value transfer	☐	Object reference (TYPE REF TO)	CL_BCB_CONTAINER		BCB Container	20040120

Event CONTAINER_DELETED Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	CONTAINER	Exporting	Value transfer	☐	Object reference (TYPE REF TO)	CL_BCB_CONTAINER		BCB Container	20040120

Event ITEM_CHANGED Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	ITEM	Exporting	Value transfer	☐	Object reference (TYPE REF TO)	CL_BCB_ITEM		BCB Item	20031113
2	ITEM_CHANGES	Exporting	Value transfer	☐	Object reference (TYPE REF TO)	CL_BCB_ITEM_CHANGES		BCB Item Changes	20031113

Event ITEM_DELETED Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	ITEM	Exporting	Value transfer	☐	Object reference (TYPE REF TO)	CL_BCB_ITEM		BCB Item	20031113
2	ITEM_CHANGES	Exporting	Value transfer	☐	Object reference (TYPE REF TO)	CL_BCB_ITEM_CHANGES		BCB Item Changes	20031113

Event ITEM_NEW Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	ITEM	Exporting	Value transfer	☐	Object reference (TYPE REF TO)	CL_BCB_ITEM		BCB Item	20031113

Event SUBSCRIPTION_ENDED Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	REASON	Exporting	Value transfer	☐	Type reference (TYPE)	BCB_TEXT_ELEMENT			20031113

History

Last changed by/on	SAP	20081007
SAP Release Created in