SAP ABAP Class CL_SRM_US_SETTING_SPACE_DEF (Definition of a User Setting Space)

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_SPACE_DEF
Short Description	Definition of a User Setting Space
Super Class
Instantiability of a Class	1	Protected
Final	☐

General Data

Message Class
Program status
Category	0
Package	SRM_RECORD_FACILITIES	Tools and Add-Ons for Records Management
Created	20010905	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_SPACE_DEF has no interface implemented.

Friends

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

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	LIST_TYPE_SETTING_DEFS	Constant	Protected	☐	Type reference (TYPE)	STRING	'SRM_USER_SETTINGS'	Type of List for Storing All User Setting Definitions	20011019
2	MY_LIST_OF_SETTING_DEFS	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_SRM_HL_LIST		List for Saving Setting Definitions for USP	20011019
3	MY_USER_SETTING_SPACE	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_SRM_US_SETTING_SPACE		User Setting Space, for Which Definition is Valid	20010905
4	PROPNAM_IS_HIDDEN	Constant	Private	☐	Type reference (TYPE)	STRING	'IS_HIDDEN'	Name of Property Is Hidden	20010905
5	PROPNAM_RESP_DEVELOPER	Constant	Private	☐	Type reference (TYPE)	STRING	'RESP_DEV'	Name of Property Responsible Developer	20010905
6	PROPNAM_RESP_ORGANIZATION	Constant	Private	☐	Type reference (TYPE)	STRING	'RESP_ORG'	Name of Property Responsible Organization	20010905
7	PROPNAM_UNDEF_SETTINGS_ALLOWED	Constant	Private	☐	Type reference (TYPE)	STRING	'UNDEF_SET_ALLOWED'	Name of Property Undefined Settings Allowed	20010905
8	SRC_CLASS	Constant	Protected	☐	Type reference (TYPE)	STRING	'CL_SRM_US_SETTING_SPACE_DEF'	Class Name for Exception Handling	20011019

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_SETTING_DEF	Instance method	Public	Method	Generate New Setting Definition for USP	20011019
2	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20010905
3	DELETE	Instance method	Protected	Method	Delete USP Description with all Setting Definitions	20020122
4	EXISTS_SETTING_DEF	Instance method	Public	Method	Does a Setting Definition Exist with the Specified Name?	20011019
5	GET_DESCRIPTION	Instance method	Public	Method	Get Description of the User Setting Space	20010905
6	GET_NAME	Instance method	Public	Method	Get Name of User Setting Space	20010905
7	GET_PARENT	Instance method	Public	Method	Get Hierarchically Superordinate User Setting Space	20010905
8	GET_PROPERTY	Instance method	Protected	Method	Get a Property of the User Setting Space From List Elements	20010905
9	GET_RESP_DEVELOPER	Instance method	Public	Method	Get Developer Responsible for the User Setting Space	20010905
10	GET_RESP_ORGANIZATION	Instance method	Public	Method	Get Organization Responsible for the User Setting Space	20010905
11	GET_SETTING_DEF	Instance method	Public	Method	Get a Setting Definition	20011019
12	GET_SETTING_DEF_LIST	Instance method	Protected	Method	Get List of Setting Definitions for the USP	20011019
13	IS_HIDDEN	Instance method	Public	Method	Is USP Hidden, so Invisible for the User?	20010905
14	IS_UNDEF_SETTING_ALLOWED	Instance method	Public	Method	Are Settings Without Definition Allowed for this USP?	20010905
15	SEARCH_SETTING_DEF_LIST_ELEM	Instance method	Protected	Method	Find List Element For Setting Definition Using Name	20011022
16	SET_DESCRIPTION	Instance method	Public	Method	Set Description of the User Setting Space	20010905
17	SET_IS_HIDDEN	Instance method	Public	Method	Set Property IS_HIDDEN for User Setting Space	20010905
18	SET_IS_UNDEF_SETTING_ALLOWED	Instance method	Public	Method	Set Property IS_UNDEF_SETTING_ALLOWED for USP	20010905
19	SET_NAME	Instance method	Public	Method	Set Name for the User Setting Space	20010905
20	SET_PROPERTY	Instance method	Protected	Method	Set Property of the User Setting Space from List Element	20010905
21	SET_RESP_DEVELOPER	Instance method	Public	Method	Set the Developer Responsible for the User Setting Space	20010905
22	SET_RESP_ORGANIZATION	Instance method	Public	Method	Set the Organization Responsible for the User Setting Space	20010905

Events

Class CL_SRM_US_SETTING_SPACE_DEF has no event.

Types

Class CL_SRM_US_SETTING_SPACE_DEF has no local type.

Method Signatures

Method ADD_SETTING_DEF 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	20011019
2	Importing	MAX_LENGTH	Call by reference	☐	Type reference (TYPE)	I	0	Max. Länge des Einstellungswerts	20011019
3	Importing	MIN_LENGTH	Call by reference	☐	Type reference (TYPE)	I	0	Min. Länge des Einstellungswerts	20011019
4	Importing	NAME	Call by reference	☐	Type reference (TYPE)	STRING		Name der Einstellung	20011019
5	Returning	SETTING_DEFINITION	Value transfer	☐	Object reference (TYPE REF TO)	CL_SRM_US_SETTING_DEF		Neue Setting Definition zum USP	20011019
6	Importing	TYPE	Call by reference	☐	Type reference (TYPE)	STRING		Typ des Einstellungswerts (nur Typ-Konstanten erlaubt)	20011019

Method ADD_SETTING_DEF on class CL_SRM_US_SETTING_SPACE_DEF has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	USER_SETTING_SPACE	Call by reference	☐	Object reference (TYPE REF TO)	CL_SRM_US_SETTING_SPACE		User Setting Space, für den die Definition gilt	20010905

Method CONSTRUCTOR on class CL_SRM_US_SETTING_SPACE_DEF has no exception.

Method DELETE Signature

Method DELETE on class CL_SRM_US_SETTING_SPACE_DEF has no parameter.
Method DELETE on class CL_SRM_US_SETTING_SPACE_DEF has no exception.

Method EXISTS_SETTING_DEF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	EXISTS	Value transfer	☐	Type reference (TYPE)	SRMRF_BOOLEAN		True, wenn USP mit geg. Namen, Vater existiert. Sonst False.	20011019
2	Importing	NAME	Call by reference	☐	Type reference (TYPE)	STRING		Name der Setting Definition	20011019

Method EXISTS_SETTING_DEF on class CL_SRM_US_SETTING_SPACE_DEF has no exception.

Method GET_DESCRIPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	DESCRIPTION	Value transfer	☐	Type reference (TYPE)	STRING		Beschreibung des User Setting Space	20010905

Method GET_DESCRIPTION on class CL_SRM_US_SETTING_SPACE_DEF 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		Name des User Setting Space	20010905

Method GET_NAME on class CL_SRM_US_SETTING_SPACE_DEF has no exception.

Method GET_PARENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	PARENT	Value transfer	☐	Object reference (TYPE REF TO)	CL_SRM_US_SETTING_SPACE		Hierarchisch übergeordneter User Setting Space	20010905

Method GET_PARENT on class CL_SRM_US_SETTING_SPACE_DEF has no exception.

Method GET_PROPERTY 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 der Eigenschaft	20010905
2	Returning	PROPERTY	Value transfer	☐	Type reference (TYPE)	STRING		Eigenschaft des User Setting Space	20010905

Method GET_PROPERTY on class CL_SRM_US_SETTING_SPACE_DEF has no exception.

Method GET_RESP_DEVELOPER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RESP_DEVELOPER	Value transfer	☐	Type reference (TYPE)	STRING		Verantwortlicher Entwickler des User Setting Space	20010905

Method GET_RESP_DEVELOPER on class CL_SRM_US_SETTING_SPACE_DEF has no exception.

Method GET_RESP_ORGANIZATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RESP_ORGANIZATION	Value transfer	☐	Type reference (TYPE)	STRING		Verantwortliche Organisation des User Setting Space	20010905

Method GET_RESP_ORGANIZATION on class CL_SRM_US_SETTING_SPACE_DEF has no exception.

Method GET_SETTING_DEF 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 der Setting Definition	20011019
2	Returning	SETTING_DEF	Value transfer	☐	Object reference (TYPE REF TO)	CL_SRM_US_SETTING_DEF		Setting Definition	20011019

Method GET_SETTING_DEF on class CL_SRM_US_SETTING_SPACE_DEF has no exception.

Method GET_SETTING_DEF_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	LIST	Value transfer	☐	Object reference (TYPE REF TO)	CL_SRM_HL_LIST		Liste, in der alle Setting Defs des USP gespeichert werden	20011019

Method GET_SETTING_DEF_LIST on class CL_SRM_US_SETTING_SPACE_DEF has no exception.

Method IS_HIDDEN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	IS_HIDDEN	Value transfer	☐	Type reference (TYPE)	SRMRF_BOOLEAN		True, wenn User Setting Space f. den Benutzer unsichtbar ist	20010905

Method IS_HIDDEN on class CL_SRM_US_SETTING_SPACE_DEF has no exception.

Method IS_UNDEF_SETTING_ALLOWED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	IS_UNDEF_SETTING_ALLOWED	Value transfer	☐	Type reference (TYPE)	SRMRF_BOOLEAN		True, wenn Settings ohne Definition für diesen USP erlaubt	20010905

Method IS_UNDEF_SETTING_ALLOWED on class CL_SRM_US_SETTING_SPACE_DEF has no exception.

Method SEARCH_SETTING_DEF_LIST_ELEM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	LIST_ELEMENT	Value transfer	☐	Object reference (TYPE REF TO)	CL_SRM_HL_LIST_ELEMENT		Listenelement zur gefundenen Setting Definition	20011022
2	Importing	NAME	Call by reference	☐	Type reference (TYPE)	STRING		Name der Setting Definition	20011022

Method SEARCH_SETTING_DEF_LIST_ELEM on class CL_SRM_US_SETTING_SPACE_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 des User Setting Space	20010905

Method SET_DESCRIPTION on class CL_SRM_US_SETTING_SPACE_DEF has no exception.

Method SET_IS_HIDDEN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_HIDDEN	Value transfer	☐	Type reference (TYPE)	SRMRF_BOOLEAN		True, wenn USP f. den Benutzer unsichtbar sein soll	20010905

Method SET_IS_HIDDEN on class CL_SRM_US_SETTING_SPACE_DEF has no exception.

Method SET_IS_UNDEF_SETTING_ALLOWED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_UNDEF_SETTING_ALLOWED	Value transfer	☐	Type reference (TYPE)	SRMRF_BOOLEAN		True, wenn Settings ohne Definition erlaubt sein sollen	20010905

Method SET_IS_UNDEF_SETTING_ALLOWED on class CL_SRM_US_SETTING_SPACE_DEF has no exception.

Method SET_NAME 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 User Setting Space	20010905

Method SET_NAME on class CL_SRM_US_SETTING_SPACE_DEF has no exception.

Method SET_PROPERTY 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 der Eigenschaft	20010905
2	Importing	PROPERTY	Value transfer	☐	Type reference (TYPE)	STRING		Eigenschaft des User Setting Space	20010905

Method SET_PROPERTY on class CL_SRM_US_SETTING_SPACE_DEF has no exception.

Method SET_RESP_DEVELOPER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	RESP_DEVELOPER	Call by reference	☐	Type reference (TYPE)	STRING		Verantwortlicher Entwickler des User Setting Space	20010905

Method SET_RESP_DEVELOPER on class CL_SRM_US_SETTING_SPACE_DEF has no exception.

Method SET_RESP_ORGANIZATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	RESP_ORGANIZATION	Call by reference	☐	Type reference (TYPE)	STRING		Verantwortliche Organisation des User Setting Space	20010905

Method SET_RESP_ORGANIZATION on class CL_SRM_US_SETTING_SPACE_DEF has no exception.

History

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