SAP ABAP Class CL_CTS_TR_LOCK (Transport lock)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-CTS-TMS-CTR (Application Component) Central CTS # Transport Management
     ⤷ SCTS_DIST_CTL_IMEX_LOCK (Package) Central CTS: Import and Export Locks

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_CTS_BOOLEAN	IF CTS Boolean Wrapper	20100709

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_CTS_PROJECT_TR_LOCK	cCTS: project specific transport lock	20110907
2	Inheritance (c INHERITING FROM c_ref)	CL_CTS_SYSTEM_TR_LOCK	cCTS: System-specific transport lock	20110907

Properties

Class	CL_CTS_TR_LOCK
Short Description	Transport lock
Super Class
Instantiability of a Class	1	Protected
Final	☐

General Data

Message Class
Program status
Category	0
Package	SCTS_DIST_CTL_IMEX_LOCK	Central CTS: Import and Export Locks
Created	20100309	SAP
Last change	20140121	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
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_CTS_TR_LOCK	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_CTS_BOOLEAN	☐	☐	IF CTS Boolean Wrapper	20100709

Friends

#	Friend	Modeled only	Created on	Description
1	CL_CTS_TR_LOCK_FACTORY	☐	20100312	Manager of import and export locks
2	CL_CTS_UI_LOCK_VIEWER	☐	20111206	Assistence Class for lock viewer UI

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CO_ANY_PROJECT	Instance attribute	Protected	☐	Type reference (TYPE)	CHAR1	'*'	Single-Character Flag	20111221
2	CO_DELIVERY_TYPE_ID	Constant	Public	☐	Type reference (TYPE)	CL_CTS_TR_LOCK=>LOCK_TYPE	'D'	The type of a lock, i.e. import or export lock	20110107
3	CO_DELIVERY_TYPE_NAME	Constant	Public	☐	Type reference (TYPE)	STRING	'Delivery'		20110107
4	CO_IMPORT_TYPE_ID	Constant	Public	☐	Type reference (TYPE)	CL_CTS_TR_LOCK=>LOCK_TYPE	'I'	The type of a lock, i.e. import or export lock	20110107
5	CO_IMPORT_TYPE_NAME	Constant	Public	☐	Type reference (TYPE)	STRING	'Import'		20110107
6	FALSE	Instance attribute	Private	☐	Attribute reference (LIKE)				20100709
7	LO_PROJECT	Instance attribute	Public	☐	Object reference (TYPE REF TO)	IF_CTS_PROJECT			20110105
8	LO_SYSTEM	Instance attribute	Public	☐	Object reference (TYPE REF TO)	IF_CTS_SYSTEM			20110105
9	LS_LOCK	Instance attribute	Protected	☐	Type reference (TYPE)	CTS_IMEXP_LOCK		Contains all locks for transport of collections	20100507
10	TRUE	Instance attribute	Private	☐	Attribute reference (LIKE)				20100709

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ACTIVATE	Instance method	Public	Method	Activate the lock	20110907
2	ADD_COLLECTION_TO_WHITELIST	Instance method	Public	Method		20110907
3	ADD_TRKORR_TO_WHITELIST	Instance method	Protected	Method		20111031
4	CREATE	Static method	Protected	Method		20100309
5	CREATE_LOCK_ON_DB	Static method	Protected	Method	inserts a lock into the DB	20111027
6	DEACTIVATE	Instance method	Public	Method	Deactivate the lock	20110907
7	DELETE_LOCK_FROM_DB	Static method	Protected	Method	deletes a lock from the DB	20111025
8	DEL_WHITELIST_ENTRIES	Instance method	Public	Method	deletes all white list entries for this lock	20111103
9	DISABLE_WHITELIST	Instance method	Public	Method	disables the usage of white list entries with this lock	20111102
10	ENABLE_WHITELIST	Instance method	Public	Method	enables the usage of white list entries with this lock	20111102
11	GET_ADD_TIMESTAMP	Instance method	Public	Method		20100312
12	GET_APPLICATION_ID	Instance method	Public	Method		20100309
13	GET_ATTRIBUTE	Instance method	Public	Method		20100309
14	GET_LOCKS_FROM_DB	Static method	Protected	Method	gets all locks from DB concerning the given filters	20111019
15	GET_LOCK_FROM_DB	Static method	Protected	Method	gets a lock by plain input values from DB	20111019
16	GET_OWNER	Instance method	Public	Method		20100309
17	GET_STRUCTURE	Instance method	Protected	Method		20100507
18	GET_SYSTEM	Instance method	Public	Method		20100309
19	GET_TYPE	Instance method	Public	Method		20100309
20	GET_TYPE_NAME	Instance method	Public	Method		20110107
21	GET_VALUE	Instance method	Public	Method		20100309
22	GET_WHITELIST	Instance method	Public	Method	returns a list of transport requests that are whitelisted	20111206
23	IS_ACTIVE	Instance method	Public	Method		20100309
24	IS_ENABLE_OVERLOAD	Instance method	Public	Method		20100309
25	REM_COLLECTION_FROM_WHITELIST	Instance method	Public	Method		20110907
26	REM_TRKORR_FROM_WHITELIST	Instance method	Protected	Method		20111031
27	TYPE_ID_TO_TYPE_NAME	Static method	Public	Method		20110107
28	TYPE_NAME_TO_TYPE_ID	Static method	Public	Method		20110107

Events

Class CL_CTS_TR_LOCK has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	APPLICATION_ID_TYPE	Public	Type reference (TYPE)	CTS_IMEXP_LOCK-APPLICATION_ID		20100309
2	ATTRIBUTE_TYPE	Public	Type reference (TYPE)	CTS_IMEXP_LOCK-ATTRIBUTE	Request attribute	20100309
3	LOCK_TYPE	Public	Type reference (TYPE)	CTS_IMEXP_LOCK-LOCK_TYPE	The type of a lock, i.e. import or export lock	20100309
4	OWNER_TYPE	Public	Type reference (TYPE)	CTS_IMEXP_LOCK-OWNER	CTS: User	20100309
5	SYSTEM_TYPE	Public	Type reference (TYPE)	CTS_IMEXP_LOCK-LOCK_SYSTEM	Transport Target of Request	20100309
6	TY_DOMAIN	Public	Type reference (TYPE)	TMSDOMNAM	TMS: Transport Domain	20111017
7	TY_LOCKS	Public	See coding			20111019	ty_locks TYPE STANDARD TABLE OF REF TO cl_cts_tr_lock WITH DEFAULT KEY
8	TY_PLAIN_LOCKS	Public	See coding			20111019	TY_PLAIN_LOCKS TYPE STANDARD TABLE OF CTS_IMEXP_LOCK WITH DEFAULT KEY
9	TY_SYSTEMS	Public	See coding			20100722	ty_systems TYPE STANDARD TABLE OF CTS_IMEXP_LOCK-LOCK_SYSTEM WITH DEFAULT KEY
10	VALUE_TYPE	Public	Type reference (TYPE)	CTS_IMEXP_LOCK-VALUE	Attribute value	20100309

Method Signatures

Method ACTIVATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	SUCCESS	Value transfer	☐	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20110907

Method ACTIVATE on class CL_CTS_TR_LOCK has no exception.

Method ADD_COLLECTION_TO_WHITELIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ADDED	Value transfer	☐	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20110907
2	Importing	ENTITY	Call by reference	☐	Object reference (TYPE REF TO)	IF_CTS_TRANSPORT_COLLECTION		Generic collection of transport entities	20110907

#	Exception	Resumable	Description	Created on
1	CX_CTS_NO_AUTHORITY	☐	No authorization for this action	20111102
2	CX_CTS_WHITELIST_NOT_ALLOWED	☐	cCTS: this lock does not allow whitelist entries	20111102

Method ADD_TRKORR_TO_WHITELIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ADDED	Value transfer	☐	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20111031
2	Importing	TRKORR	Call by reference	☐	Type reference (TYPE)	TRKORR		Request/Task	20111031

#	Exception	Resumable	Description	Created on
1	CX_CTS_NO_AUTHORITY	☐	No authorization for this action	20111102
2	CX_CTS_WHITELIST_NOT_ALLOWED	☐	cCTS: this lock does not allow whitelist entries	20111102

Method CREATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ACTIVE	Call by reference	☑	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20100309
2	Importing	ADD_TIMESTAMP	Call by reference	☑	Type reference (TYPE)	TIMESTAMP		UTC Time Stamp in Short Form (YYYYMMDDhhmmss)	20100312
3	Importing	APPLICATION_ID	Call by reference	☐	Type reference (TYPE)	CL_CTS_TR_LOCK=>APPLICATION_ID_TYPE			20100309
4	Importing	ATTRIBUTE	Call by reference	☑	Type reference (TYPE)	CL_CTS_TR_LOCK=>ATTRIBUTE_TYPE		Request attribute	20100309
5	Importing	ENABLE_OVERLOAD	Call by reference	☑	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20100309
6	Importing	IO_PROJECT	Call by reference	☑	Object reference (TYPE REF TO)	IF_CTS_PROJECT			20110107
7	Importing	IO_SYSTEM	Call by reference	☐	Object reference (TYPE REF TO)	IF_CTS_SYSTEM		Transport Target of Request	20110110
8	Returning	LOCK	Value transfer	☐	Object reference (TYPE REF TO)	CL_CTS_TR_LOCK		Transport lock	20100309
9	Importing	OWNER	Call by reference	☑	Type reference (TYPE)	CL_CTS_TR_LOCK=>OWNER_TYPE		CTS: User	20100309
10	Importing	TYPE	Call by reference	☐	Type reference (TYPE)	CL_CTS_TR_LOCK=>LOCK_TYPE		The type of a lock, i.e. import or export lock	20100309
11	Importing	VALUE	Call by reference	☑	Type reference (TYPE)	CL_CTS_TR_LOCK=>VALUE_TYPE		Attribute value	20100309

#	Exception	Resumable	Description	Created on
1	CX_CTS_TR_LOCKING	☐	cCTS: Exception Class for transport locks	20110107

Method CREATE_LOCK_ON_DB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_LOCK	Call by reference	☐	Type reference (TYPE)	CTS_IMEXP_LOCK		Contains all locks for transport of collections	20111027

#	Exception	Resumable	Description	Created on
1	CX_CTS_LOCK_DOES_ALREADY_EXIST	☐	cCTS: Transport lock does already exist	20111027

Method DEACTIVATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	SUCCESS	Value transfer	☐	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20110907

Method DEACTIVATE on class CL_CTS_TR_LOCK has no exception.

Method DELETE_LOCK_FROM_DB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_LOCK	Call by reference	☑	Object reference (TYPE REF TO)	CL_CTS_TR_LOCK		Transport lock	20111025
2	Importing	IS_LOCK	Call by reference	☑	Type reference (TYPE)	CTS_IMEXP_LOCK		Contains all locks for transport of collections	20111026
3	Returning	RV_DELETED	Value transfer	☐	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20111025

#	Exception	Resumable	Description	Created on
1	CX_CTS_NO_AUTHORITY	☐	No authorization for this action	20111025

Method DEL_WHITELIST_ENTRIES Signature

Method DEL_WHITELIST_ENTRIES on class CL_CTS_TR_LOCK has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_CTS_NO_AUTHORITY	☐	No authorization for this action	20111103

Method DISABLE_WHITELIST Signature

Method DISABLE_WHITELIST on class CL_CTS_TR_LOCK has no parameter.
Method DISABLE_WHITELIST on class CL_CTS_TR_LOCK has no exception.

Method ENABLE_WHITELIST Signature

Method ENABLE_WHITELIST on class CL_CTS_TR_LOCK has no parameter.
Method ENABLE_WHITELIST on class CL_CTS_TR_LOCK has no exception.

Method GET_ADD_TIMESTAMP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	TIMESTAMP	Value transfer	☐	Type reference (TYPE)	TIMESTAMP		UTC Time Stamp in Short Form (YYYYMMDDhhmmss)	20100312

Method GET_ADD_TIMESTAMP on class CL_CTS_TR_LOCK has no exception.

Method GET_APPLICATION_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	APPLICATION_ID	Value transfer	☐	Type reference (TYPE)	CL_CTS_TR_LOCK=>APPLICATION_ID_TYPE			20100309

Method GET_APPLICATION_ID on class CL_CTS_TR_LOCK has no exception.

Method GET_ATTRIBUTE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ATTRIBUTE	Value transfer	☐	Type reference (TYPE)	CL_CTS_TR_LOCK=>ATTRIBUTE_TYPE		Request attribute	20100309

Method GET_ATTRIBUTE on class CL_CTS_TR_LOCK has no exception.

Method GET_LOCKS_FROM_DB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_APPLICATION_ID	Call by reference	☑	Type reference (TYPE)	APPLICATION_ID_TYPE			20111019
2	Returning	RT_LOCKS	Value transfer	☐	Type reference (TYPE)	TY_PLAIN_LOCKS			20111019

Method GET_LOCKS_FROM_DB on class CL_CTS_TR_LOCK has no exception.

Method GET_LOCK_FROM_DB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_APPLICATION_ID	Call by reference	☐	Type reference (TYPE)	CL_CTS_TR_LOCK=>APPLICATION_ID_TYPE			20111019
2	Importing	IV_ATTRIBUTE	Call by reference	☐	Type reference (TYPE)	CL_CTS_TR_LOCK=>ATTRIBUTE_TYPE		Request attribute	20111019
3	Importing	IV_DOMAIN	Call by reference	☐	Type reference (TYPE)	CL_CTS_TR_LOCK=>TY_DOMAIN			20111019
4	Importing	IV_LOCK_TYPE	Call by reference	☐	Type reference (TYPE)	CL_CTS_TR_LOCK=>LOCK_TYPE		The type of a lock, i.e. import or export lock	20111019
5	Importing	IV_SYSTEM	Call by reference	☐	Type reference (TYPE)	CL_CTS_TR_LOCK=>SYSTEM_TYPE		Transport Target of Request	20111019
6	Importing	IV_VALUE	Call by reference	☐	Type reference (TYPE)	CL_CTS_TR_LOCK=>VALUE_TYPE		Attribute value	20111019
7	Returning	RS_LOCK	Value transfer	☐	Type reference (TYPE)	CTS_IMEXP_LOCK		Transport lock	20111019

#	Exception	Resumable	Description	Created on
1	CX_CTS_LOCK_DOES_NOT_EXIST	☐	cCTS: the lock does not exist	20111019

Method GET_OWNER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	OWNER	Value transfer	☐	Type reference (TYPE)	CL_CTS_TR_LOCK=>OWNER_TYPE		CTS: User	20100309

Method GET_OWNER on class CL_CTS_TR_LOCK has no exception.

Method GET_STRUCTURE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	LOCK	Value transfer	☐	Type reference (TYPE)	CTS_IMEXP_LOCK		Contains all locks for transport of collections	20100507

Method GET_STRUCTURE on class CL_CTS_TR_LOCK has no exception.

Method GET_SYSTEM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_SYSTEM	Value transfer	☐	Object reference (TYPE REF TO)	IF_CTS_SYSTEM			20110107

Method GET_SYSTEM on class CL_CTS_TR_LOCK has no exception.

Method GET_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	TYPE	Value transfer	☐	Type reference (TYPE)	CL_CTS_TR_LOCK=>LOCK_TYPE		The type of a lock, i.e. import or export lock	20100309

Method GET_TYPE on class CL_CTS_TR_LOCK has no exception.

Method GET_TYPE_NAME Signature

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

Method GET_TYPE_NAME on class CL_CTS_TR_LOCK has no exception.

Method GET_VALUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	VALUE	Value transfer	☐	Type reference (TYPE)	CL_CTS_TR_LOCK=>VALUE_TYPE		Attribute value	20100309

Method GET_VALUE on class CL_CTS_TR_LOCK has no exception.

Method GET_WHITELIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_WHITELIST	Value transfer	☐	Type reference (TYPE)	TRKORRS		Table of Request Numbers	20111206

Method GET_WHITELIST on class CL_CTS_TR_LOCK has no exception.

Method IS_ACTIVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	IS_ACTIVE	Value transfer	☐	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20100309

Method IS_ACTIVE on class CL_CTS_TR_LOCK has no exception.

Method IS_ENABLE_OVERLOAD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ENABLE_OVERLOAD	Value transfer	☐	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20100309

Method IS_ENABLE_OVERLOAD on class CL_CTS_TR_LOCK has no exception.

Method REM_COLLECTION_FROM_WHITELIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ENTITY	Call by reference	☐	Object reference (TYPE REF TO)	IF_CTS_TRANSPORT_COLLECTION		Generic collection of transport entities	20110907
2	Returning	REMOVED	Value transfer	☐	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20110907

#	Exception	Resumable	Description	Created on
1	CX_CTS_NO_AUTHORITY	☐	No authorization for this action	20111102

Method REM_TRKORR_FROM_WHITELIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	REMOVED	Value transfer	☐	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20111031
2	Importing	TRKORR	Call by reference	☐	Type reference (TYPE)	TRKORR		Request/Task	20111031

#	Exception	Resumable	Description	Created on
1	CX_CTS_NO_AUTHORITY	☐	No authorization for this action	20111102

Method TYPE_ID_TO_TYPE_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	EV_LONG_TYPE	Value transfer	☐	Type reference (TYPE)	STRING			20110107
2	Importing	IV_SHORT_TYPE	Call by reference	☐	Type reference (TYPE)	CL_CTS_TR_LOCK=>LOCK_TYPE		The type of a lock, i.e. import or export lock	20110107

Method TYPE_ID_TO_TYPE_NAME on class CL_CTS_TR_LOCK has no exception.

Method TYPE_NAME_TO_TYPE_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	EV_SHORT_TYPE	Value transfer	☐	Type reference (TYPE)	CL_CTS_TR_LOCK=>LOCK_TYPE		The type of a lock, i.e. import or export lock	20110107
2	Importing	IV_LONG_TYPE	Call by reference	☐	Type reference (TYPE)	STRING			20110107

Method TYPE_NAME_TO_TYPE_ID on class CL_CTS_TR_LOCK has no exception.

History

Last changed by/on	SAP	20140121
SAP Release Created in	702