SAP ABAP Class CL_NWECM_PATH (ECMI: Path Representation and Handling)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-ECM-ABA-COR (Application Component) ECM Core Infrastructure
⤷
S_NWECM_COMMONS (Package) ECMI Common Classes of API and SPI
⤷
⤷
Meta Relationship - Using
| # | Relationship type | Using | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | IF_SERIALIZABLE_OBJECT | Serializable Object | 20090827 |
Properties
| Class | CL_NWECM_PATH | |
| Short Description | ECMI: Path Representation and Handling | |
| Super Class | ||
| Instantiability of a Class | 0 | Private |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | S_NWECM_COMMONS | ECMI Common Classes of API and SPI |
| Created | 20080722 | 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) |
Interfaces
| # | Interface | Abstract | Final | Description | Created on |
|---|---|---|---|---|---|
| 1 | IF_SERIALIZABLE_OBJECT | Serializable Object | 20090827 |
Friends
Class CL_NWECM_PATH has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Instance attribute | Private | Object reference (TYPE REF TO) | CL_NWECM_PATH | 20081203 | ||||
| 2 | Instance attribute | Private | Type reference (TYPE) | STRING | Cached leaf node name | 20081007 | |||
| 3 | Instance attribute | Private | Type reference (TYPE) | STRING | 20080722 | ||||
| 4 | Constant | Public | Type reference (TYPE) | STRING | '/' | Path Separator | 20081014 | ||
| 5 | Static Attribute | Public | Object reference (TYPE REF TO) | CL_NWECM_PATH | Root Path | 20081014 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Method | Treats current path as folder and adds the given path | 20081013 | |
| 2 | Static method | Public | Method | Checks if the given string is a valid path segment | 20090223 | |
| 3 | Static method | Public | Constructor | CLASS_CONSTRUCTOR | 20081014 | |
| 4 | Instance method | Private | Constructor | CONSTRUCTOR | 20080722 | |
| 5 | Instance method | Public | Method | Checks if this path is equal to the argument | 20081128 | |
| 6 | Instance method | Public | Method | Returns the name of the leaf | 20081007 | |
| 7 | Instance method | Public | Method | Returns the parent path of this path | 20081007 | |
| 8 | Static method | Public | Method | Returns a path object for the given path string | 20081127 | |
| 9 | Instance method | Public | Method | Checks if this path is a prefix of the argument | 20081128 | |
| 10 | Instance method | Public | Method | Checks if this path is a (trivial) prefix of the argument | 20081128 | |
| 11 | Instance method | Public | Method | Checks wether this path is empty | 20090225 | |
| 12 | Instance method | Private | Method | Parse and return path elements | 20081007 | |
| 13 | Instance method | Public | Method | Returns a table of strings with the path segments | 20080730 | |
| 14 | Instance method | Public | Method | Returns '/'-separated notation of this path | 20080722 |
Events
Class CL_NWECM_PATH has no event.
Types
Class CL_NWECM_PATH has no local type.
Method Signatures
Method ADD Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_SEGMENT | Value transfer | Type reference (TYPE) | STRING | Segment to add to the current path. Can be path-like too. | 20081013 | |||
| 2 | RO_PATH | Value transfer | Object reference (TYPE REF TO) | CL_NWECM_PATH | The new path containing the appended segment. | 20081013 |
Method ADD on class CL_NWECM_PATH has no exception.
Method CHECK_SEGMENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_SEGMENT | Value transfer | Type reference (TYPE) | STRING | 20090223 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | NW ECM: Illegal Argument Exception | 20090223 |
Method CLASS_CONSTRUCTOR Signature
Method CLASS_CONSTRUCTOR on class CL_NWECM_PATH has no parameter.
Method CLASS_CONSTRUCTOR on class CL_NWECM_PATH has no exception.
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_PATH | Value transfer | Type reference (TYPE) | STRING | 20080722 |
Method CONSTRUCTOR on class CL_NWECM_PATH has no exception.
Method EQUALS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IO_OTHER | Value transfer | Object reference (TYPE REF TO) | CL_NWECM_PATH | NW ECM: Path Representation and Handling | 20081128 | |||
| 2 | RV_EQUALS | Value transfer | Type reference (TYPE) | ABAP_BOOL | 20081203 |
Method EQUALS on class CL_NWECM_PATH has no exception.
Method GET_NAME Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_NAME | Value transfer | Type reference (TYPE) | STRING | Name of leaf node | 20081007 |
Method GET_NAME on class CL_NWECM_PATH has no exception.
Method GET_PARENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RO_PARENT | Value transfer | Object reference (TYPE REF TO) | CL_NWECM_PATH | 20081203 |
Method GET_PARENT on class CL_NWECM_PATH has no exception.
Method GET_PATH Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_PATH | Value transfer | Type reference (TYPE) | STRING | 20081127 | ||||
| 2 | RO_PATH | Value transfer | Object reference (TYPE REF TO) | CL_NWECM_PATH | NW ECM: Path Representation and Handling | 20081127 |
Method GET_PATH on class CL_NWECM_PATH has no exception.
Method IS_ANCESTOR_OF Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IO_OTHER | Value transfer | Object reference (TYPE REF TO) | CL_NWECM_PATH | NW ECM: Path Representation and Handling | 20081128 | |||
| 2 | RV_IS_ANCESTOR_OF | Value transfer | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE if this path is a prefix of IO_OTHER | 20081128 |
Method IS_ANCESTOR_OF on class CL_NWECM_PATH has no exception.
Method IS_ANCESTOR_OF_OR_SELF Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IO_OTHER | Value transfer | Object reference (TYPE REF TO) | CL_NWECM_PATH | NW ECM: Path Representation and Handling | 20081128 | |||
| 2 | RV_IS_ANCESTOR_OF_OR_SELF | Value transfer | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE if this path is a (trivial) prefix of IO_OTHER | 20081128 |
Method IS_ANCESTOR_OF_OR_SELF on class CL_NWECM_PATH has no exception.
Method IS_EMPTY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_IS_EMPTY | Value transfer | Type reference (TYPE) | ABAP_BOOL | 20090225 |
Method IS_EMPTY on class CL_NWECM_PATH has no exception.
Method PARSE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EO_PARENT | Value transfer | Object reference (TYPE REF TO) | CL_NWECM_PATH | 20081203 | ||||
| 2 | EV_NAME | Value transfer | Type reference (TYPE) | STRING | Name of leaf node | 20081007 |
Method PARSE on class CL_NWECM_PATH has no exception.
Method SPLIT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RT_SEGMENTS | Value transfer | Type reference (TYPE) | NWECM_T_STRING | Table of Strings | 20080730 |
Method SPLIT on class CL_NWECM_PATH has no exception.
Method TO_STRING Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_PATH | Value transfer | Type reference (TYPE) | STRING | 20080722 |
Method TO_STRING on class CL_NWECM_PATH has no exception.
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in | 712 |