SAP ABAP Class CL_COS_UTILITIES (Utility routines for content separation/client separation)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-ABA-LA (Application Component) Syntax, Compiler, Runtime
⤷
SCOS_DELIVERED (Package) Component Separation: Delivered contents
⤷
⤷
Properties
| Class | CL_COS_UTILITIES | |
| Short Description | Utility routines for content separation/client separation | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | SCOS_DELIVERED | Component Separation: Delivered contents |
| Created | 20090727 | SAP |
| Last change | 20110908 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) | |
| 2 | Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) | |
| 3 | Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) | |
| 4 | Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) |
Interfaces
Class CL_COS_UTILITIES has no interface implemented.
Friends
Class CL_COS_UTILITIES has no friend class.
Attributes
Class CL_COS_UTILITIES has no attribute.
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Static method | Public | Method | Assert if the function is executed in the specified context | 20090730 | |
| 2 | Static method | Private | Method | Raises an exception if current client is not a system client | 20090727 | |
| 3 | Static method | Public | Method | Disable the function in the specified context | 20090730 | |
| 4 | Static method | Public | Method | Returns the actual client | 20090729 | |
| 5 | Static method | Public | Method | Check if the function is executable in the specified context | 20090730 | |
| 6 | Static method | Public | Method | Checks if the current client is an application client | 20090729 | |
| 7 | Static method | Public | Method | Checks if the system is in By Design mode | 20090729 | |
| 8 | Static method | Private | Method | Checks if the system runs in development mode | 20090731 | |
| 9 | Static method | Private | Method | Checks if the system runs in productive mode | 20090731 | |
| 10 | Static method | Public | Method | Checks if the system is in Suite mode | 20090729 | |
| 11 | Static method | Public | Method | Checks if the current client is configured as system client | 20090729 | |
| 12 | Static method | Private | Method | Logs the error using log-points | 20090804 |
Events
Class CL_COS_UTILITIES has no event.
Types
Class CL_COS_UTILITIES has no local type.
Method Signatures
Method ASSERT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IO_CLIENT | Call by reference | Object reference (TYPE REF TO) | CL_COS_CLIENT | CL_COS_CLIENT=>SC_NONE | System/Application/All/None | 20090730 | ||
| 2 | IO_SYSTEM | Call by reference | Object reference (TYPE REF TO) | CL_COS_SYSTEM | CL_COS_SYSTEM=>SC_NONE | ByD/Suite/All/None | 20090730 | ||
| 3 | IV_ADDITIONAL_MESSAGE | Value transfer | Type reference (TYPE) | STRING | 20090730 | ||||
| 4 | IV_COMPONENT | Value transfer | Type reference (TYPE) | STRING | Name of Unit | 20090730 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20090731 |
Method CHECK_IS_SYSTEM_CLIENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_ADDITIONAL_INFO | Value transfer | Type reference (TYPE) | STRING | Specific info regarding actual situation | 20090727 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Indicates that current client is not a system client | 20090727 |
Method DISABLE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IO_CLIENT | Call by reference | Object reference (TYPE REF TO) | CL_COS_CLIENT | CL_COS_CLIENT=>SC_NONE | System/Application/All/None | 20090730 | ||
| 2 | IO_SYSTEM | Call by reference | Object reference (TYPE REF TO) | CL_COS_SYSTEM | CL_COS_SYSTEM=>SC_NONE | ByD/Suite/All/None | 20090730 | ||
| 3 | IV_ADDITIONAL_MESSAGE | Value transfer | Type reference (TYPE) | STRING | 20090731 | ||||
| 4 | IV_COMPONENT | Value transfer | Type reference (TYPE) | STRING | Name of Unit | 20090731 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20090731 |
Method GET_CLIENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_CLIENT | Value transfer | Type reference (TYPE) | MANDT | Client | 20090729 |
Method GET_CLIENT on class CL_COS_UTILITIES has no exception.
Method IS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IO_CLIENT | Call by reference | Object reference (TYPE REF TO) | CL_COS_CLIENT | CL_COS_CLIENT=>SC_NONE | System/Application/All/None | 20090730 | ||
| 2 | IO_SYSTEM | Call by reference | Object reference (TYPE REF TO) | CL_COS_SYSTEM | CL_COS_SYSTEM=>SC_NONE | ByD/Suite/All/None | 20090730 | ||
| 3 | RV_IS_ALLOWED | Value transfer | Type reference (TYPE) | ABAP_BOOL | 20090730 |
Method IS on class CL_COS_UTILITIES has no exception.
Method IS_APPLICATION_CLIENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_IS_APPLICATION_CLIENT | Value transfer | Type reference (TYPE) | ABAP_BOOL | 20090729 |
Method IS_APPLICATION_CLIENT on class CL_COS_UTILITIES has no exception.
Method IS_BYD Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_IS_BYD | Value transfer | Type reference (TYPE) | ABAP_BOOL | 20090729 |
Method IS_BYD on class CL_COS_UTILITIES has no exception.
Method IS_DEVELOPMENT_USE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_IS_DEVELOPMENT_USE | Value transfer | Type reference (TYPE) | ABAP_BOOL | 20090731 |
Method IS_DEVELOPMENT_USE on class CL_COS_UTILITIES has no exception.
Method IS_PRODUCTIVE_USE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_IS_PRODUCTIVE_USE | Value transfer | Type reference (TYPE) | ABAP_BOOL | 20090731 |
Method IS_PRODUCTIVE_USE on class CL_COS_UTILITIES has no exception.
Method IS_SUITE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_IS_SUITE | Value transfer | Type reference (TYPE) | ABAP_BOOL | 20090729 |
Method IS_SUITE on class CL_COS_UTILITIES has no exception.
Method IS_SYSTEM_CLIENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_IS_SYSTEM_CLIENT | Value transfer | Type reference (TYPE) | ABAP_BOOL | 20090729 |
Method IS_SYSTEM_CLIENT on class CL_COS_UTILITIES has no exception.
Method LOG_EXCEPTION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IO_EXC | Call by reference | Object reference (TYPE REF TO) | CX_ROOT | Abstract Superclass for All Global Exceptions | 20090804 |
Method LOG_EXCEPTION on class CL_COS_UTILITIES has no exception.
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in | 72L |