SAP ABAP Class CL_SRM_US_SETTING_DEF (Definition of a User Setting)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-RM (Application Component) SAP Records Management
     ⤷ SRM_RECORD_FACILITIES (Package) Tools and Add-Ons for Records Management

Properties

Class	CL_SRM_US_SETTING_DEF
Short Description	Definition of a User Setting
Super Class
Instantiability of a Class	0	Private
Final	☐

General Data

Message Class
Program status
Category	0
Package	SRM_RECORD_FACILITIES	Tools and Add-Ons for Records Management
Created	20011012	SAP
Last change	00000000	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	SRMRF	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_SRM_US_SETTING_DEF has no interface implemented.

Friends

#	Friend	Modeled only	Created on	Description
1	CL_SRM_US_SETTING_SPACE	☐	20011022	Namespace for User Settings (Hierarchically Organized)
2	CL_SRM_US_SETTING_SPACE_DEF	☐	20011019	Definition of a User Setting Space

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	C_TYPE_BOOLEAN	Constant	Public	☐	Type reference (TYPE)	STRING	'B'	Boolean Type	20011012
2	C_TYPE_INT	Constant	Public	☐	Type reference (TYPE)	STRING	'I'	Type Integer	20011012
3	C_TYPE_STRING	Constant	Public	☐	Type reference (TYPE)	STRING	'S'	Type String	20011012
4	C_TYPE_STRUCT	Constant	Public	☐	Type reference (TYPE)	STRING	'C'	Structure	20020313
5	MY_LIST_ELEMENT	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_SRM_HL_LIST_ELEMENT		List Element in Which Setting Definition is Saved	20011012
6	MY_NAME	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Setting Name	20011012
7	MY_USER_SETTING_SPACE	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_SRM_US_SETTING_SPACE		User Setting Space to Which Setting Belongs	20011022
8	PROPNAM_MAX_LENGTH	Constant	Private	☐	Type reference (TYPE)	STRING	'MAX_LENGTH'	Name of Property Maximum Length	20011012
9	PROPNAM_MIN_LENGTH	Constant	Private	☐	Type reference (TYPE)	STRING	'MIN_LENGTH'	Name of Property Minimum Length	20011012
10	PROPNAM_TYPE	Constant	Private	☐	Type reference (TYPE)	STRING	'TYPE'	Name of Property Type	20011012
11	SRC_CLASS	Constant	Protected	☐	Type reference (TYPE)	STRING	'CL_SRM_US_SETTING_DEF'	Class Name for Exception Handling	20011015

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_VALUE	Instance method	Public	Method	Check Value of a Setting	20011022
2	CONSTRUCTOR	Instance method	Public	Constructor	Constructor (Privat;Off. with CL_SRM_USER_SETTING_SPACE_DEF)	20011012
3	CREATE	Static method	Protected	Method	Creating a Setting Definition	20011015
4	GET_DESCRIPTION	Instance method	Public	Method	Get Setting Description	20011015
5	GET_LIST_ELEMENT_VALUE	Instance method	Protected	Method	Gets Value From Value Set of the List Element	20011012
6	GET_MAX_LENGTH	Instance method	Public	Method	Get Maximum Length of Setting Value	20011012
7	GET_MIN_LENGTH	Instance method	Public	Method	Get Minimum Length of Setting Value	20011012
8	GET_TYPE	Instance method	Public	Method	Get Type of Setting Value	20011012
9	SET_DESCRIPTION	Instance method	Public	Method	Set Description of Setting	20011015
10	SET_LIST_ELEMENT_VALUE	Instance method	Protected	Method	Set Value in Value Set of List Element	20011012
11	SET_MIN_MAX_LENGTH	Instance method	Public	Method	Set Minimum, Maximum Length of Setting Value (0 = any)	20011015
12	SET_TYPE	Instance method	Public	Method	Set Setting Value Type	20011015

Events

Class CL_SRM_US_SETTING_DEF has no event.

Types

Class CL_SRM_US_SETTING_DEF has no local type.

Method Signatures

Method CHECK_VALUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ACCESSED_VIA_TYPE	Call by reference	☐	Type reference (TYPE)	STRING	''	Typ, über den auf die Einstellung zugegriffen werden soll	20011022
2	Importing	CHECK_CONVERSION	Call by reference	☐	Type reference (TYPE)	SRMRF_BOOLEAN	SRMRF_FALSE	Datentyp mittels Konvertierungsversuch prüfen?	20011022
3	Importing	VALUE	Call by reference	☐	Type reference (TYPE)	STRING		Zu prüfender Wert der Einstellung	20011022

Method CHECK_VALUE on class CL_SRM_US_SETTING_DEF has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	LIST_ELEMENT	Call by reference	☐	Object reference (TYPE REF TO)	CL_SRM_HL_LIST_ELEMENT		Listenelement, in dem die Einstellung gespeichert ist	20011012
2	Importing	NAME	Call by reference	☐	Type reference (TYPE)	STRING		Name der Einstellung	20011012
3	Importing	SETTING_SPACE	Call by reference	☐	Object reference (TYPE REF TO)	CL_SRM_US_SETTING_SPACE		User Setting Space, zu dem die Einstellung gehört	20011022

Method CONSTRUCTOR on class CL_SRM_US_SETTING_DEF has no exception.

Method CREATE 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		Beschreibung der Einstellung	20011015
2	Importing	LIST_ELEMENT	Call by reference	☐	Object reference (TYPE REF TO)	CL_SRM_HL_LIST_ELEMENT		Listenelement, in dem die Einstellung gespeichert ist	20011015
3	Importing	MAX_LENGTH	Call by reference	☐	Type reference (TYPE)	I	0	Max. Länge des Einstellungswerts	20011015
4	Importing	MIN_LENGTH	Call by reference	☐	Type reference (TYPE)	I	0	Min. Länge des Einstellungswerts	20011015
5	Importing	NAME	Call by reference	☐	Type reference (TYPE)	STRING		Name der Einstellung	20011015
6	Returning	SETTING_DEFINITION	Value transfer	☐	Object reference (TYPE REF TO)	CL_SRM_US_SETTING_DEF		Neue Setting Definition	20011015
7	Importing	SETTING_SPACE	Call by reference	☐	Object reference (TYPE REF TO)	CL_SRM_US_SETTING_SPACE		User Setting Space, zu dem die Einstellung gehört	20011022
8	Importing	TYPE	Call by reference	☐	Type reference (TYPE)	STRING		Typ des Einstellungswerts (nur Typ-Konstanten erlaubt)	20011015

Method CREATE on class CL_SRM_US_SETTING_DEF has no exception.

Method GET_DESCRIPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	STRING		Beschreibung der Einstellung	20011015

Method GET_DESCRIPTION on class CL_SRM_US_SETTING_DEF has no exception.

Method GET_LIST_ELEMENT_VALUE 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		Name des zu lesenden Wertes	20011012
2	Returning	VALUE	Value transfer	☐	Type reference (TYPE)	STRING		Inhalt des Wertes	20011012

Method GET_LIST_ELEMENT_VALUE on class CL_SRM_US_SETTING_DEF has no exception.

Method GET_MAX_LENGTH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	I		Max. Länge des Einstellungswerts	20011012

Method GET_MAX_LENGTH on class CL_SRM_US_SETTING_DEF has no exception.

Method GET_MIN_LENGTH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	I		Min. Länge des Einstellungswerts	20011012

Method GET_MIN_LENGTH on class CL_SRM_US_SETTING_DEF has no exception.

Method GET_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	STRING		Typ des Einstellungswerts	20011012

Method GET_TYPE on class CL_SRM_US_SETTING_DEF has no exception.

Method SET_DESCRIPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DESCRIPTION	Value transfer	☐	Type reference (TYPE)	STRING		Beschreibung der Einstellung	20011015

Method SET_DESCRIPTION on class CL_SRM_US_SETTING_DEF has no exception.

Method SET_LIST_ELEMENT_VALUE 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		Name des zu setzenden Wertes	20011012
2	Importing	VALUE	Call by reference	☐	Type reference (TYPE)	STRING		Zu setzender Inhalt des Wertes	20011012

Method SET_LIST_ELEMENT_VALUE on class CL_SRM_US_SETTING_DEF has no exception.

Method SET_MIN_MAX_LENGTH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	MAX_LENGTH	Value transfer	☐	Type reference (TYPE)	I	0	Max. Länge des Einstellungswerts	20011015
2	Importing	MIN_LENGTH	Value transfer	☐	Type reference (TYPE)	I	0	Min. Länge des Einstellungswerts	20011015

Method SET_MIN_MAX_LENGTH on class CL_SRM_US_SETTING_DEF has no exception.

Method SET_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	TYPE	Value transfer	☐	Type reference (TYPE)	STRING		Typ des Einstellungswerts (nur Typ-Konstanten erlaubt)	20011015

Method SET_TYPE on class CL_SRM_US_SETTING_DEF has no exception.

History

Last changed by/on	SAP	00000000
SAP Release Created in	610