SAP ABAP Interface IF_CLS_CHARACTERIZATION (Interface for BAdI: CLS_CHARACTERIZATION)

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 composition (i COMPRISING i_ref)	IF_CLS_ATTRIBUTE	Attribute	20050705
2	Interface implementation (CLASS c. INTERFACES i_ref)	CL_CLS_ATTRIBUTE	Attribute	20050705
3	Interface implementation (CLASS c. INTERFACES i_ref)	CL_CLS_BADI_CHARACTERIZATION	Wrap badi CLS_CHARACTERIZATION	20070927
4	Interface implementation (CLASS c. INTERFACES i_ref)	CL_CLS_CHARACTERIZATION_ROOT	Default-Implementierung	20050704

Properties

Interface	IF_CLS_CHARACTERIZATION
Short Description	Interface for BAdI: CLS_CHARACTERIZATION

General Data

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

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_BADI_INTERFACE	☐	☐	Tag Interface for BAdIs	20050704

Friends

Interface IF_CLS_CHARACTERIZATION has no friend.

Attributes

Interface IF_CLS_CHARACTERIZATION has no attribute.

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	AUTHORITY_CHECK	Instance method	Public	Method	Authority Check	20120903
2	CHECK_ASSIGNMENT	Instance method	Public	Method	Check the consistency of a characterization	20050704
3	CHECK_ASSIGNMENT_WITH_CONTEXT	Instance method	Public	Method	Check the consistency of a characterization with context	20050705
4	CONTEXT_MENU	Instance method	Public	Method	Create new entries in the context menu (start with ACTION:)	20050926
5	GET_DEFAULTS_FOR_OBJECT	Instance method	Public	Method	Get the default value(s)	20050705
6	GET_EFFECTIVE_VALUE	Instance method	Public	Method	Compute effective value from two values	20050711
7	GET_EXTERNAL_REPRESENTATION	Instance method	Public	Method	Get external representation of classification values	20090115
8	GET_INTERNAL_REPRESENTATION	Instance method	Public	Method	Get internal representation of classification values	20090115
9	GET_LINKED_ATTRIBUTES	Instance method	Public	Method	List of characteristics that have to changed simultaneously	20060410
10	GET_LINKED_OBJECTS	Instance method	Public	Method	Compute list of linked objects	20050711
11	HANDLE_CONTEXT_MENU_COMMAND	Instance method	Public	Method	Handle commands that start with ACTION:	20050926
12	HAS_OWN_COMPUTATION_OF_EFF_VAL	Instance method	Public	Method	Has own computation of effective value	20070320
13	REFRESH	Instance method	Public	Method	Clear any cached values	20061220
14	SET_UP_CHARACTERIZATION	Instance method	Public	Method	Initialize Badi. Do not redefine.	20050705

Events

Interface IF_CLS_CHARACTERIZATION has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_ASSIGNMENT_LIST	Public	See coding			20050705	TY_ASSIGNMENT_LIST type hashed table of ref to if_cls_attr_value_assignment with unique key table_line

Method Signatures

Method AUTHORITY_CHECK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_ATTRIBUTE	Call by reference	☐	Type reference (TYPE)	CLS_ATTRIBUTE_NAME		Characteristic	20120903
2	Importing	IM_GUID	Call by reference	☐	Type reference (TYPE)	GUID_32		GUID of classification	20120903
3	Importing	IM_LOCK_MODE	Call by reference	☐	Type reference (TYPE)	CL_PAK_WB_DOMAINS=>TY_LOCK_MODE		Create / Display / Change	20120903
4	Importing	IM_OBJECT	Call by reference	☐	Type reference (TYPE)	PAK_OBJECT_KEY		Classified object	20120903
5	Importing	IM_PACKAGE	Call by reference	☑	Type reference (TYPE)	DEVCLASS		Package of classification	20120903

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

Method CHECK_ASSIGNMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_ASSIGNMENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_CLS_ATTR_VALUE_ASSIGNMENT		Attribute value assignment	20050705
2	Importing	IM_ATTRIBUTE	Call by reference	☐	Object reference (TYPE REF TO)	IF_CLS_ATTRIBUTE		Attribute	20050706

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

Method CHECK_ASSIGNMENT_WITH_CONTEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_ASSIGNMENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_CLS_ATTR_VALUE_ASSIGNMENT		Attribute value assignment	20050705
2	Importing	IM_CONTEXT	Call by reference	☐	Type reference (TYPE)	TY_ASSIGNMENT_LIST		Context - other attributes that are edited concurrently	20050705

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

Method CONTEXT_MENU Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_ATTRIBUTE	Call by reference	☐	Type reference (TYPE)	CLS_ATTRIBUTE_NAME		Characteristic	20050926
2	Importing	IM_MENU	Call by reference	☐	Object reference (TYPE REF TO)	CL_CTMENU		Context Menu	20050926
3	Importing	IM_OBJECTS	Call by reference	☐	Type reference (TYPE)	PAK_HASHED_OBJECT_LIST		List of development objects	20050926
4	Importing	IM_STRUCTURE_NODE_SELECTED	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL			20050926
5	Importing	IM_VALUE	Call by reference	☐	Type reference (TYPE)	CLS_ATTRIBUTE_VALUE		Attribute value	20070208

Method CONTEXT_MENU on Interface IF_CLS_CHARACTERIZATION has no exception.

Method GET_DEFAULTS_FOR_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_VALUES	Call by reference	☐	Type reference (TYPE)	CLS_VALUE_ASSIGNMENTS		Default value(s)	20050705
2	Importing	IM_ATTRIBUTE	Call by reference	☑	Type reference (TYPE)	CLS_ATTRIBUTE_NAME		Characteristic	20060804
3	Importing	IM_OBJECT	Call by reference	☐	Type reference (TYPE)	PAK_OBJECT_KEY		Object	20050705

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

Method GET_EFFECTIVE_VALUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_VALUE_A	Call by reference	☐	Type reference (TYPE)	CLIKE			20050711
2	Importing	IM_VALUE_B	Call by reference	☐	Type reference (TYPE)	CLIKE			20050711
3	Returning	RE_EFFECTIVE_VALUE	Value transfer	☐	Type reference (TYPE)	CLS_ATTRIBUTE_VALUE		Attribute value	20050711

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

Method GET_EXTERNAL_REPRESENTATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_INTERNAL_VALUE	Call by reference	☐	Type reference (TYPE)	CLIKE		Internal value	20090115
2	Returning	RE_EXTERNAL_VALUE	Value transfer	☐	Type reference (TYPE)	CLS_ATTRIBUTE_VALUE		Attribute value	20090115

#	Exception	Resumable	Description	Created on
1	CX_CLS_INVALID_ASSIGNMENT_DATA	☐	Invalid Classification	20090115

Method GET_INTERNAL_REPRESENTATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_EXTERNAL_VALUE	Call by reference	☐	Type reference (TYPE)	CLIKE		Internal value	20090115
2	Returning	RE_INTERNAL_VALUE	Value transfer	☐	Type reference (TYPE)	CLS_ATTRIBUTE_VALUE		Attribute value	20090115

#	Exception	Resumable	Description	Created on
1	CX_CLS_INVALID_ASSIGNMENT_DATA	☐	Invalid Classification	20090115

Method GET_LINKED_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_LINKED_ATTRIBUTES	Call by reference	☐	Type reference (TYPE)	CLS_ATTRIBUTE_TAB		Table of attribute name	20060410

Method GET_LINKED_ATTRIBUTES on Interface IF_CLS_CHARACTERIZATION has no exception.

Method GET_LINKED_OBJECTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_LINKED_OBJECTS	Call by reference	☐	Type reference (TYPE)	PAK_OBJECT_LIST		List of development objects	20050711
2	Importing	IM_ATTRIBUTE	Call by reference	☐	Type reference (TYPE)	CLS_ATTRIBUTE_NAME		Characteristic	20070320
3	Importing	IM_OBJECT	Call by reference	☐	Type reference (TYPE)	PAK_OBJECT_KEY		Object key	20050711

Method GET_LINKED_OBJECTS on Interface IF_CLS_CHARACTERIZATION has no exception.

Method HANDLE_CONTEXT_MENU_COMMAND Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_ATTRIBUTE	Call by reference	☐	Type reference (TYPE)	CLS_ATTRIBUTE_NAME		Characteristic	20050926
2	Importing	IM_FCODE	Call by reference	☐	Type reference (TYPE)	SY-UCOMM		Function code that PAI triggered	20050926
3	Importing	IM_OBJECTS	Call by reference	☐	Type reference (TYPE)	PAK_HASHED_OBJECT_LIST		List of development objects	20050926
4	Importing	IM_VALUE	Call by reference	☐	Type reference (TYPE)	CLS_VALUE_ASSIGNMENT		Assigned value as string	20060804
5	Importing	IM_WB_MANAGER	Call by reference	☑	Object reference (TYPE REF TO)	IF_WB_MANAGER		Interface for Workbench Manager	20051227

Method HANDLE_CONTEXT_MENU_COMMAND on Interface IF_CLS_CHARACTERIZATION has no exception.

Method HAS_OWN_COMPUTATION_OF_EFF_VAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_RESULT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20070320

Method HAS_OWN_COMPUTATION_OF_EFF_VAL on Interface IF_CLS_CHARACTERIZATION has no exception.

Method REFRESH Signature

Method REFRESH on Interface IF_CLS_CHARACTERIZATION has no parameter.
Method REFRESH on Interface IF_CLS_CHARACTERIZATION has no exception.

Method SET_UP_CHARACTERIZATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_ATTRIBUTE_REF	Call by reference	☐	Object reference (TYPE REF TO)	IF_CLS_ATTRIBUTE		Characteristic name	20050705

Method SET_UP_CHARACTERIZATION on Interface IF_CLS_CHARACTERIZATION has no exception.

History

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