SAP ABAP Interface IF_CRM_CIC_OP_CLUSTER (Object Provider Cluster)

Hierarchy

☛ BBPCRM (Software Component) BBPCRM
   ⤷ CRM-CIC (Application Component) Interaction Center WinClient
     ⤷ CRM_CIC_COMPONENTS (Package) Interaction Center components

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	CL_CRM_CIC_OP_CLUSTER	Object Provider Service: Cluster	19991026

Properties

Interface	IF_CRM_CIC_OP_CLUSTER
Short Description	Object Provider Cluster

General Data

Package	CRM_CIC_COMPONENTS	Interaction Center components
Created	19991015	SAP
Last changed	20050705	SAP
Unicode checks active	☑

Forward declarations

Interface IF_CRM_CIC_OP_CLUSTER has no forward declaration.

Interfaces

Interface IF_CRM_CIC_OP_CLUSTER has no interface.

Friends

Interface IF_CRM_CIC_OP_CLUSTER has no friend.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CARGO	Instance attribute	Public	☑	Object reference (TYPE REF TO)	IF_CRM_CIC_CARGO		Cargo container for client use	19991026
2	CLUSTER_TYPE	Instance attribute	Public	☐	Type reference (TYPE)	CRM_CIC_OP_CLUSTER_TYPE		Cluster type	19991015
3	CO_FALSE	Constant	Public	☐	Type reference (TYPE)	EBA_FLAG	' '	Flag value: false	19991015
4	CO_NUMBER_AUTO	Constant	Public	☐	Type reference (TYPE)	I	-1010101010	Magic value for autodetection of number of childeren	19991015
5	CO_TRUE	Constant	Public	☐	Type reference (TYPE)	EBA_FLAG	'X'	Flag value: true	19991015
6	TOUCHED	Instance attribute	Public	☐	Type reference (TYPE)	EBA_FLAG		Loop prevention: flag for touched clusters	19991021

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_CHILD	Instance method	Public	Method	Add a subcluster to the cluster	19991015
2	BUILD	Instance method	Public	Method	Explicit request for building the cluster	19991015
3	CREATE_CHILD	Instance method	Public	Method	Add a new subcluster	19991015
4	CREATE_CHILDREN_FROM_OBJECTS	Instance method	Public	Method	Add multiple new subsclusters with reference to objects	19991015
5	CREATE_CHILD_FROM_OBJECT	Instance method	Public	Method	Add a new subcluster with reference to an object	19991015
6	GET_ALL_CHILDREN	Instance method	Public	Method	Get all children	19991015
7	GET_CHILDREN_OF_TYPE	Instance method	Public	Method	Get all children of a specific type	19991015
8	GET_NUMBER_OF_CHILDREN	Instance method	Public	Method	Get the number of dependend subclusters	19991015
9	GET_NUMBER_OF_CHILDREN_AUTO	Instance method	Public	Method	Get the number of dependend subclusters (automatically)	20001212
10	GET_REF_OBJECT	Instance method	Public	Method	Get the reference object of the cluster node	19991015
11	IS_BUILT	Instance method	Public	Method	Return flag: Cluster is already built	19991015
12	IS_IGNORE	Instance method	Public	Method	Return flag for cluster client: Ignore this cluster	20000125
13	IS_LINKED_TO_OBJECT	Instance method	Public	Method	Return flag: Cluster has reference object	19991015
14	REMOVE_ALL_CHILDREN	Instance method	Public	Method	Remove all children	19991015
15	REMOVE_CHILD	Instance method	Public	Method	Remove one subcluster	19991015
16	REMOVE_CHILDREN_OF_TYPE	Instance method	Public	Method	Remove all children of a specific type	19991015
17	REMOVE_REF_OBJECT	Instance method	Public	Method	Remove the reference object of the cluster	19991015
18	RESET_BUILT	Instance method	Public	Method	Reset flag: Cluster is already built	19991015
19	RESET_IGNORE	Instance method	Public	Method	Reset flag for cluster client: Ignore this cluster (use sub~	19991015
20	RESET_TOUCHED	Instance method	Public	Method	Resets touched-flags of this cluster and all subclusters	19991021
21	SET_BUILT	Instance method	Public	Method	Set flag: Cluster is already built	19991015
22	SET_CLUSTER_BUILDER	Instance method	Public	Method	Set the cluster builder object	19991015
23	SET_IGNORE	Instance method	Public	Method	Set flag for cluster client: Ignore this cluster (use sub~)	19991015
24	SET_NUMBER_OF_CHILDREN	Instance method	Public	Method	Sets the number of children	19991015
25	SET_REF_OBJECT	Instance method	Public	Method	Set the reference object of the cluster node	19991015

Events

Interface IF_CRM_CIC_OP_CLUSTER has no event.

Types

Interface IF_CRM_CIC_OP_CLUSTER has no local type.

Method Signatures

Method ADD_CHILD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_SUBCLUSTER	Call by reference	☐	Object reference (TYPE REF TO)	IF_CRM_CIC_OP_CLUSTER		Subcluster to be added	19991015

Method ADD_CHILD on Interface IF_CRM_CIC_OP_CLUSTER has no exception.

Method BUILD Signature

Method BUILD on Interface IF_CRM_CIC_OP_CLUSTER has no parameter.
Method BUILD on Interface IF_CRM_CIC_OP_CLUSTER has no exception.

Method CREATE_CHILD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_TYPE	Call by reference	☐	Type reference (TYPE)	CRM_CIC_OP_CLUSTER_TYPE		Cluster Type	19991015
2	Returning	RE_SUBCLUSTER	Value transfer	☐	Object reference (TYPE REF TO)	IF_CRM_CIC_OP_CLUSTER		New subcluster	19991015

Method CREATE_CHILD on Interface IF_CRM_CIC_OP_CLUSTER has no exception.

Method CREATE_CHILDREN_FROM_OBJECTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_REF_OBJECT_TAB	Call by reference	☐	Type reference (TYPE)	CCM_OP_OBJECT_TAB		Table of reference objects	19991015
2	Importing	IM_TYPE	Call by reference	☑	Type reference (TYPE)	CRM_CIC_OP_CLUSTER_TYPE		Cluster type	19991015
3	Returning	RE_SUBCLUSTER_TAB	Value transfer	☐	Type reference (TYPE)	CRM_CIC_OP_CLUSTER_TAB		Table of new subclusters	19991015

Method CREATE_CHILDREN_FROM_OBJECTS on Interface IF_CRM_CIC_OP_CLUSTER has no exception.

Method CREATE_CHILD_FROM_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_REF_OBJECT	Call by reference	☐	Object reference (TYPE REF TO)	IF_CCM_OP_OBJECT		Reference object	19991015
2	Importing	IM_TYPE	Call by reference	☑	Type reference (TYPE)	CRM_CIC_OP_CLUSTER_TYPE		Cluster type	19991015
3	Returning	RE_SUBCLUSTER	Value transfer	☐	Object reference (TYPE REF TO)	IF_CRM_CIC_OP_CLUSTER		New subcluster	19991015

Method CREATE_CHILD_FROM_OBJECT on Interface IF_CRM_CIC_OP_CLUSTER has no exception.

Method GET_ALL_CHILDREN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_NO_IGNORED_NODES	Call by reference	☐	Type reference (TYPE)	EBA_FLAG	SPACE	Flag: Suppress "ignored" nodes	20001212
2	Importing	IM_NO_VIRTUAL_NODES	Call by reference	☐	Type reference (TYPE)	EBA_FLAG	SPACE	Flag: Only nodes with ref object	20000725
3	Returning	RE_SUBCLUSTER_TAB	Value transfer	☐	Type reference (TYPE)	CRM_CIC_OP_CLUSTER_TAB		Table of subclusters	19991015

Method GET_ALL_CHILDREN on Interface IF_CRM_CIC_OP_CLUSTER has no exception.

Method GET_CHILDREN_OF_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_TYPE	Call by reference	☐	Type reference (TYPE)	CRM_CIC_OP_CLUSTER_TYPE		Cluster Type	19991015
2	Returning	RE_SUBCLUSTER_TAB	Value transfer	☐	Type reference (TYPE)	CRM_CIC_OP_CLUSTER_TAB		Table of subclusters	19991015

Method GET_CHILDREN_OF_TYPE on Interface IF_CRM_CIC_OP_CLUSTER has no exception.

Method GET_NUMBER_OF_CHILDREN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_NUMBER_OF_CHILDREN	Value transfer	☐	Type reference (TYPE)	I		Number of dependend subclusters	19991015

Method GET_NUMBER_OF_CHILDREN on Interface IF_CRM_CIC_OP_CLUSTER has no exception.

Method GET_NUMBER_OF_CHILDREN_AUTO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_NO_IGNORED_NODES	Call by reference	☐	Type reference (TYPE)	EBA_FLAG	SPACE	Flag: suppress "ignored" nodes	20001212
2	Importing	IM_NO_VIRTUAL_NODES	Call by reference	☐	Type reference (TYPE)	EBA_FLAG	SPACE	Flag: only nodes with reference object	20001212
3	Returning	RE_NUMBER_OF_CHILDREN	Value transfer	☐	Type reference (TYPE)	I		Number of dependend subclusters	20001212

Method GET_NUMBER_OF_CHILDREN_AUTO on Interface IF_CRM_CIC_OP_CLUSTER has no exception.

Method GET_REF_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_REF_OBJECT	Value transfer	☐	Object reference (TYPE REF TO)	IF_CCM_OP_OBJECT		Reference Object	19991015

#	Exception	Resumable	Description	Created on
1	NO_REF_OBJECT	☐	No reference object assigned to cluster	19991015

Method IS_BUILT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_IS_BUILT	Value transfer	☐	Type reference (TYPE)	EBA_FLAG		Flag: Cluster has been built (no more subclusters)	19991015

Method IS_BUILT on Interface IF_CRM_CIC_OP_CLUSTER has no exception.

Method IS_IGNORE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_IS_IGNORE	Value transfer	☐	Type reference (TYPE)	EBA_FLAG		flag	20000125

Method IS_IGNORE on Interface IF_CRM_CIC_OP_CLUSTER has no exception.

Method IS_LINKED_TO_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_HAS_REF_OBJECT	Value transfer	☐	Type reference (TYPE)	EBA_FLAG		Flag: Cluster has assigned reference object	19991015

Method IS_LINKED_TO_OBJECT on Interface IF_CRM_CIC_OP_CLUSTER has no exception.

Method REMOVE_ALL_CHILDREN Signature

Method REMOVE_ALL_CHILDREN on Interface IF_CRM_CIC_OP_CLUSTER has no parameter.
Method REMOVE_ALL_CHILDREN on Interface IF_CRM_CIC_OP_CLUSTER has no exception.

Method REMOVE_CHILD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_SUBCLUSTER	Call by reference	☐	Object reference (TYPE REF TO)	IF_CRM_CIC_OP_CLUSTER		Subcluster to be deleted	19991015

#	Exception	Resumable	Description	Created on
1	NOT_FOUND	☐	Subcluster doesn't exist	19991015

Method REMOVE_CHILDREN_OF_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_TYPE	Call by reference	☐	Type reference (TYPE)	CRM_CIC_OP_CLUSTER_TYPE		Cluster Type	19991015

#	Exception	Resumable	Description	Created on
1	NOT_FOUND	☐	No subclusters of specified type available	19991015

Method REMOVE_REF_OBJECT Signature

Method REMOVE_REF_OBJECT on Interface IF_CRM_CIC_OP_CLUSTER has no parameter.

#	Exception	Resumable	Description	Created on
1	NO_REF_OBJECT	☐	Cluster as no reference object	19991015

Method RESET_BUILT Signature

Method RESET_BUILT on Interface IF_CRM_CIC_OP_CLUSTER has no parameter.
Method RESET_BUILT on Interface IF_CRM_CIC_OP_CLUSTER has no exception.

Method RESET_IGNORE Signature

Method RESET_IGNORE on Interface IF_CRM_CIC_OP_CLUSTER has no parameter.
Method RESET_IGNORE on Interface IF_CRM_CIC_OP_CLUSTER has no exception.

Method RESET_TOUCHED Signature

Method RESET_TOUCHED on Interface IF_CRM_CIC_OP_CLUSTER has no parameter.
Method RESET_TOUCHED on Interface IF_CRM_CIC_OP_CLUSTER has no exception.

Method SET_BUILT Signature

Method SET_BUILT on Interface IF_CRM_CIC_OP_CLUSTER has no parameter.
Method SET_BUILT on Interface IF_CRM_CIC_OP_CLUSTER has no exception.

Method SET_CLUSTER_BUILDER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_CLUSTER_BUILDER	Call by reference	☐	Object reference (TYPE REF TO)	IF_CRM_CIC_OP_CLUSTER_BUILDER		Cluster builder	19991015

Method SET_CLUSTER_BUILDER on Interface IF_CRM_CIC_OP_CLUSTER has no exception.

Method SET_IGNORE Signature

Method SET_IGNORE on Interface IF_CRM_CIC_OP_CLUSTER has no parameter.
Method SET_IGNORE on Interface IF_CRM_CIC_OP_CLUSTER has no exception.

Method SET_NUMBER_OF_CHILDREN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_NUMBER_OF_CHILDREN	Call by reference	☐	Type reference (TYPE)	I		Set number of dependend subclusters	19991015

Method SET_NUMBER_OF_CHILDREN on Interface IF_CRM_CIC_OP_CLUSTER has no exception.

Method SET_REF_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_ADDITIONAL_SELECTIONS	Call by reference	☑	Type reference (TYPE)	ECRM_CIC_OP_CLUSTER_SEL_TAB		Additional selection criteria	20001123
2	Importing	IM_REF_OBJECT	Call by reference	☐	Object reference (TYPE REF TO)	IF_CCM_OP_OBJECT		Reference object for cluster	19991015

Method SET_REF_OBJECT on Interface IF_CRM_CIC_OP_CLUSTER has no exception.

History

Last changed by/on	SAP	20050705
SAP Release Created in