SAP ABAP Class CL_SRM_KC_KEYWORD_CATALOG (Keyword Catalog)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-RM (Application Component) SAP Records Management
     ⤷ SRM_KEYWORD_CATALOG (Package) Records Management: Key Word Catalog

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_SRM_KC_ABSTR_ELEMENT	Element of Keyword Catalog	20020614

Properties

Class	CL_SRM_KC_KEYWORD_CATALOG
Short Description	Keyword Catalog
Super Class	CL_SRM_KC_ABSTR_ELEMENT	Element of Keyword Catalog
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	SRM_KEYWORD_CATALOG	Records Management: Key Word Catalog
Created	20020603	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	CL_SRM	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
2	SRMKC	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
3	SRMRF	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_SRM_KC_KEYWORD_CATALOG has no interface implemented.

Friends

#	Friend	Modeled only	Created on	Description
1	CL_SRM_KC_SEARCH_TABLES	☐	20060511	Tables for the keyword search

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	INPUT_AT_SELECTION_POSSIBLE	Instance attribute	Protected	☐	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20020603
2	KEYWORDS_TO_UPPER_CASE	Instance attribute	Protected	☐	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20020703
3	MY_DESCRIPTION	Static Attribute	Protected	☐	Type reference (TYPE)	STRING			20020606
4	MY_LANGUAGE	Static Attribute	Protected	☐	Type reference (TYPE)	STRING			20020606
5	MY_LIST	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_SRM_HL_LIST		List for Keyword Catalog	20020606
6	MY_NAME	Instance attribute	Public	☐	Type reference (TYPE)	STRING			20020606

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_ENTRY	Instance method	Public	Method	Add Keyword to Catalog	20020618
2	ADD_TO_EXCLUSION_LIST	Instance method	Public	Method	Add Keyword to Exclusion List	20020603
3	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20020607
4	CREATE_LIST	Static method	Public	Method		20020617
5	DELETE_ALL_KEYWORDS	Instance method	Private	Method	Deletes all keywords in a list from the search tables	20060512
6	GET_EXCLUSION_LIST	Instance method	Public	Method		20020603
7	GET_HL_LIST	Instance method	Private	Method	Returns the hierarchical list for this keyword catalog	20060511
8	GET_KEYWORD	Instance method	Public	Method		20020620
9	GET_NAME	Instance method	Public	Method		20020614
10	GET_PROPERTIES	Instance method	Public	Method		20020603
11	INSERT_KEYWORD	Instance method	Private	Method	Fills keyword tables to allow quicker searches	20060512
12	SEARCH_KEYWORD	Instance method	Public	Method		20020603
13	SET_PROPERTIES	Instance method	Public	Method		20020603
14	TRANSPORT	Instance method	Public	Method	Transport Keyword Catalog	20030902
15	UPDATE_KEYWORD	Instance method	Public	Method		20020703

Events

Class CL_SRM_KC_KEYWORD_CATALOG has no event.

Types

Class CL_SRM_KC_KEYWORD_CATALOG has no local type.

Method Signatures

Method ADD_ENTRY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DESCRIPTION	Call by reference	☑	Type reference (TYPE)	STRING			20020618
2	Importing	ELEMENT_TYPE	Call by reference	☐	Type reference (TYPE)	STRING		Listenelementtyp	20020620
3	Importing	INSERT_POSITION	Call by reference	☐	Type reference (TYPE)	SRMRF_HL_INSERTION_POS			20020618
4	Returning	KEYWORD	Value transfer	☐	Object reference (TYPE REF TO)	CL_SRM_KC_KEYWORD		Listenelement	20020618
5	Importing	NAME	Call by reference	☐	Type reference (TYPE)	STRING			20020618
6	Importing	PARENT	Call by reference	☐	Object reference (TYPE REF TO)	CL_SRM_KC_ABSTR_ELEMENT		Element des Schlagwortkatalogs	20020618
7	Importing	SIBLING	Call by reference	☐	Object reference (TYPE REF TO)	CL_SRM_KC_ABSTR_ELEMENT		Element des Schlagwortkatalogs	20020618

Method ADD_ENTRY on class CL_SRM_KC_KEYWORD_CATALOG has no exception.

Method ADD_TO_EXCLUSION_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DESCRIPTION	Call by reference	☐	Type reference (TYPE)	STRING			20020701
2	Importing	ELEMENT_TYPE	Call by reference	☐	Type reference (TYPE)	STRING			20020701
3	Importing	INSERT_POSITION	Call by reference	☐	Type reference (TYPE)	SRMRF_HL_INSERTION_POS			20020701
4	Returning	KEYWORD	Value transfer	☐	Object reference (TYPE REF TO)	CL_SRM_KC_KEYWORD		Schlagwort	20020701
5	Importing	NAME	Call by reference	☐	Type reference (TYPE)	STRING			20020603

Method ADD_TO_EXCLUSION_LIST on class CL_SRM_KC_KEYWORD_CATALOG has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NAME	Call by reference	☐	Type reference (TYPE)	STRING			20020607

Method CONSTRUCTOR on class CL_SRM_KC_KEYWORD_CATALOG has no exception.

Method CREATE_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DESCRIPTION	Call by reference	☐	Type reference (TYPE)	STRING			20020617
2	Importing	FREE_INPUT_POSSIBLE	Call by reference	☐	Type reference (TYPE)	SRMKC_BOOLEAN			20020725
3	Importing	INPUT_AT_SELECTION_POSSIBLE	Call by reference	☐	Type reference (TYPE)	SRMKC_BOOLEAN			20020709
4	Returning	KC_LIST	Value transfer	☐	Object reference (TYPE REF TO)	CL_SRM_KC_KEYWORD_CATALOG		Hierachical List: Liste	20020617
5	Importing	LANGUAGE	Call by reference	☐	Type reference (TYPE)	STRING			20020617
6	Importing	NAME	Call by reference	☐	Type reference (TYPE)	STRING			20020617
7	Importing	UPPER_CASE	Call by reference	☑	Type reference (TYPE)	SRMKC_BOOLEAN			20020703

Method CREATE_LIST on class CL_SRM_KC_KEYWORD_CATALOG has no exception.

Method DELETE_ALL_KEYWORDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_LIST_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Namee des Schlagwortkataloges	20060512

Method DELETE_ALL_KEYWORDS on class CL_SRM_KC_KEYWORD_CATALOG has no exception.

Method GET_EXCLUSION_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	COLLECTION	Call by reference	☐	Object reference (TYPE REF TO)	CL_SRM_RF_ELEMENT_ITER		Schlagwort	20020603

Method GET_EXCLUSION_LIST on class CL_SRM_KC_KEYWORD_CATALOG has no exception.

Method GET_HL_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_HL_LIST	Value transfer	☐	Object reference (TYPE REF TO)	CL_SRM_HL_LIST		hierarchische Liste	20060511

Method GET_HL_LIST on class CL_SRM_KC_KEYWORD_CATALOG has no exception.

Method GET_KEYWORD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	KEYWORD	Value transfer	☐	Object reference (TYPE REF TO)	CL_SRM_HL_LIST_ELEMENT		Schlagwort	20020620
2	Importing	KEYWORD_ID	Call by reference	☐	Type reference (TYPE)	SRMKCKEYID		ID des Schlagwortes im Baum	20020620

Method GET_KEYWORD on class CL_SRM_KC_KEYWORD_CATALOG has no exception.

Method GET_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	NAME	Value transfer	☐	Type reference (TYPE)	STRING			20020614

Method GET_NAME on class CL_SRM_KC_KEYWORD_CATALOG has no exception.

Method GET_PROPERTIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	MY_VALUE	Call by reference	☐	Type reference (TYPE)	STRING			20020703
2	Exporting	PROPERTIES	Call by reference	☐	Object reference (TYPE REF TO)	CL_SRM_RF_VALUE_SET		Schlagwort	20020606

Method GET_PROPERTIES on class CL_SRM_KC_KEYWORD_CATALOG has no exception.

Method INSERT_KEYWORD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_DESCRIPTION	Value transfer	☑	Type reference (TYPE)	STRING		Schlagwort Beschreibung	20060512
2	Importing	IM_HL_LIST_ELEMENT	Call by reference	☐	Object reference (TYPE REF TO)	CL_SRM_HL_LIST_ELEMENT		Hierachical List: List Element	20060512
3	Importing	IM_NAME	Value transfer	☐	Type reference (TYPE)	STRING		Schlagwort Name	20060512

Method INSERT_KEYWORD on class CL_SRM_KC_KEYWORD_CATALOG has no exception.

Method SEARCH_KEYWORD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	KEYWORDS	Call by reference	☐	Type reference (TYPE)	TSRMKCNAMES		Schlagwort	20020626
2	Exporting	KEYWORD_LIST	Call by reference	☐	Object reference (TYPE REF TO)	CL_SRM_RF_ELEMENT_ITER		Schlagwort	20020607
3	Importing	PREFIX	Call by reference	☐	Type reference (TYPE)	STRING			20020731

Method SEARCH_KEYWORD on class CL_SRM_KC_KEYWORD_CATALOG has no exception.

Method SET_PROPERTIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PROPERTIES	Call by reference	☐	Object reference (TYPE REF TO)	CL_SRM_RF_VALUE_SET		Schlagwort	20020606

Method SET_PROPERTIES on class CL_SRM_KC_KEYWORD_CATALOG has no exception.

Method TRANSPORT Signature

Method TRANSPORT on class CL_SRM_KC_KEYWORD_CATALOG has no parameter.
Method TRANSPORT on class CL_SRM_KC_KEYWORD_CATALOG has no exception.

Method UPDATE_KEYWORD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DESCRIPTION	Call by reference	☐	Type reference (TYPE)	STRING			20020703
2	Importing	KEYID	Call by reference	☐	Type reference (TYPE)	SRMKCKEYID		ID des Schlagwortes im Baum	20020703
3	Importing	NAME	Call by reference	☐	Type reference (TYPE)	STRING			20020703

Method UPDATE_KEYWORD on class CL_SRM_KC_KEYWORD_CATALOG has no exception.

History

Last changed by/on	SAP	20110908
SAP Release Created in	620