Hierarchy
⤷
⤷
Properties
| Class | CL_CFX_ECN_HLP | |
| Short Description | Helper class for the ECN Operations | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | CFX_FOLDERS | Collaboration Folders: Folder and Documents |
| Created | 20051214 | SAP |
| Last change | 20141109 | |
| 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 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) | |
| 3 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) | |
| 4 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) | |
| 5 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Class CL_CFX_ECN_HLP has no interface implemented.
Friends
Class CL_CFX_ECN_HLP has no friend class.
Attributes
Class CL_CFX_ECN_HLP has no attribute.
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Static method | Public | Method | Method to attach the objects to the ECN | 20060119 | |
| 2 | Static method | Public | Method | check if version exists for the obj to be attached | 20060203 | |
| 3 | Static method | Public | Method | check if the user has write auth on the obj | 20060220 | |
| 4 | Static method | Public | Method | create a new version for the attached object | 20060220 | |
| 5 | Static method | Public | Method | delete the values from the CFX_ECN_OBJ table | 20060801 | |
| 6 | Static method | Public | Method | Method to filter objects that are not attached to other ECNs | 20060112 | |
| 7 | Static method | Public | Method | Utility Method to Get All Subfolders' Ids for Given Topic | 20060621 | |
| 8 | Static method | Private | Method | Utility Method to Get All Child Topics as a List | 20060621 | |
| 9 | Static method | Public | Method | Method to get the objects attached to the ECN | 20060125 | |
| 10 | Static method | Public | Method | Gets the ECN details for an object | 20060308 | |
| 11 | Static method | Private | Method | Insert the values to the CFX_ ECN_OBJ table. | 20060609 | |
| 12 | Static method | Public | Method | Check if the user has auth on att obj to release ECN | 20060221 | |
| 13 | Static method | Public | Method | Check if the ECN is released | 20060221 | |
| 14 | Static method | Public | Method | to check if the object is attachable to an ECN or not | 20060217 | |
| 15 | Static method | Public | Method | to check if the object is attached to the ECN or not. | 20060217 | |
| 16 | Static method | Public | Method | Method to Lock ECN Attached Objects | 20060901 | |
| 17 | Static method | Public | Method | Make ECN object readonly | 20061218 | |
| 18 | Static method | Public | Event handling method | will be called when the deletion is completed. | 20060801 | |
| 19 | Static method | Public | Event handling method | will be called before copy of all documents | 20060804 | |
| 20 | Static method | Public | Event handling method | will be called when the deletion is in progress. | 20060801 | |
| 21 | Static method | Public | Event handling method | Will be called when version is being created | 20060609 | |
| 22 | Static method | Public | Method | Method to Release a ECN | 20060127 | |
| 23 | Static method | Private | Method | Search ECNs in a collaboration without using TREX | 20060516 | |
| 24 | Static method | Private | Method | Search ECNs in a collaboration using TREX | 20060516 | |
| 25 | Static method | Public | Method | Gets all the ECNs under a Collaboration with given ID | 20060424 | |
| 26 | Static method | Public | Method | Method to Un Lock ECN Attached Objects | 20060901 | |
| 27 | Static method | Public | Method | Make the ECN object not readonly | 20061218 |
Events
Class CL_CFX_ECN_HLP has no event.
Types
Class CL_CFX_ECN_HLP has no local type.
Method Signatures
Method ATTACH_OBJS_TO_ECN Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CT_RESULT | Call by reference | Type reference (TYPE) | CFX_TT_SEARCH_OBJECT | CFX Search: Search Result | 20061129 | |||
| 2 | I_ECN_ID | Call by reference | Type reference (TYPE) | GUID_32 | GUID in 'CHAR' Format in Uppercase | 20060119 |
Method ATTACH_OBJS_TO_ECN on class CL_CFX_ECN_HLP has no exception.
Method CHK_VER_EXISTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_OBJ_ID | Call by reference | Type reference (TYPE) | GUID_32 | CFX Search: Search Result | 20060217 | |||
| 2 | R_FLAG | Value transfer | Type reference (TYPE) | CFX_BOOLEAN | Boolean Type | 20060217 |
Method CHK_VER_EXISTS on class CL_CFX_ECN_HLP has no exception.
Method CHK_WRITE_AUTH_OBJ Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_OBJ_ID | Call by reference | Type reference (TYPE) | GUID_32 | GUID in 'CHAR' Format in Uppercase | 20060220 | |||
| 2 | R_FLAG | Value transfer | Type reference (TYPE) | CFX_BOOLEAN | abap_false if no auth | 20060220 |
Method CHK_WRITE_AUTH_OBJ on class CL_CFX_ECN_HLP has no exception.
Method CREATE_VER_ATT_OBJ Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | E_CURRENT_VERSION | Call by reference | Type reference (TYPE) | GUID_32 | New Version number of the object | 20060220 | |||
| 2 | E_ERROR_FLAG | Call by reference | Type reference (TYPE) | CFX_BOOLEAN | Boolean Type | 20060220 | |||
| 3 | I_OBJ_ID | Call by reference | Type reference (TYPE) | GUID_32 | GUID in 'CHAR' Format in Uppercase | 20060220 |
Method CREATE_VER_ATT_OBJ on class CL_CFX_ECN_HLP has no exception.
Method DEL_ECN_OBJ_ATTR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_ECN_ID | Call by reference | Type reference (TYPE) | GUID_32 | GUID in 'CHAR' Format in Uppercase | 20060801 | |||
| 2 | I_OBJ_ID | Call by reference | Type reference (TYPE) | GUID_32 | GUID in 'CHAR' Format in Uppercase | 20060801 |
Method DEL_ECN_OBJ_ATTR on class CL_CFX_ECN_HLP has no exception.
Method FILTER_ECN_RELEVENT_OBJECTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CP_RESULT | Call by reference | Object reference (TYPE REF TO) | CL_CFX_SEARCH_RESULT | CFX Search: Search Result | 20061129 | |||
| 2 | I_ECN_ID | Call by reference | Type reference (TYPE) | GUID_32 | GUID in 'CHAR' Format in Uppercase | 20060119 |
Method FILTER_ECN_RELEVENT_OBJECTS on class CL_CFX_ECN_HLP has no exception.
Method GET_ALL_SUBFOLDER_IDS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IP_TOPIC | Call by reference | Object reference (TYPE REF TO) | CL_CFX_TOPIC | Collaboration: Topic | 20060621 | |||
| 2 | RT_FOLDER_IDS | Value transfer | Type reference (TYPE) | CFX_TT_AREA_TOPIC_FOL | CFX: List of Assignments of Folder to Area + Topic | 20060621 |
Method GET_ALL_SUBFOLDER_IDS on class CL_CFX_ECN_HLP has no exception.
Method GET_CHILD_TOPIC_LIST Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IP_TOPIC | Call by reference | Object reference (TYPE REF TO) | CL_CFX_TOPIC | Collaboration: Topic | 20060621 | |||
| 2 | RT_TOPICS | Value transfer | Type reference (TYPE) | CFX_TT_TOPIC_LIST | List of Topics | 20060621 |
Method GET_CHILD_TOPIC_LIST on class CL_CFX_ECN_HLP has no exception.
Method GET_ECN_ATT_OBJS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_OBJ_IDS | Call by reference | Type reference (TYPE) | CFX_TT_GUID_32 | GUID in 'CHAR' Format in Uppercase | 20061129 | |||
| 2 | I_ECN_ID | Call by reference | Type reference (TYPE) | GUID_32 | GUID in 'CHAR' Format in Uppercase | 20060127 |
Method GET_ECN_ATT_OBJS on class CL_CFX_ECN_HLP has no exception.
Method GET_ECN_DETAILS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_ECN_OBJ | Call by reference | Type reference (TYPE) | CFX_TT_ECN_OBJ | Application table to store objects linked to an ECN. | 20060308 | |||
| 2 | E_FLAG | Value transfer | Type reference (TYPE) | CFX_BOOLEAN | Boolean Type | 20060308 | |||
| 3 | I_DOC_ID | Call by reference | Type reference (TYPE) | GUID_32 | GUID in 'CHAR' Format in Uppercase | 20060308 |
Method GET_ECN_DETAILS on class CL_CFX_ECN_HLP has no exception.
Method INS_ECN_OBJ_ATTR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IS_ECN_OBJ | Value transfer | Type reference (TYPE) | CFX_ECN_OBJ | Application table to store objects linked to an ECN. | 20060609 |
Method INS_ECN_OBJ_ATTR on class CL_CFX_ECN_HLP has no exception.
Method IS_ECN_RELEASABLE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | E_FLAG | Value transfer | Type reference (TYPE) | CFX_BOOLEAN | abap_true if the ecn can be released by user | 20060221 | |||
| 2 | E_MSG_TXT | Call by reference | Type reference (TYPE) | STRING | Error Message | 20060221 | |||
| 3 | I_ECN_ID | Call by reference | Type reference (TYPE) | GUID_32 | GUID in 'CHAR' Format in Uppercase | 20060221 |
Method IS_ECN_RELEASABLE on class CL_CFX_ECN_HLP has no exception.
Method IS_ECN_RELEASED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_ECN_ID | Call by reference | Type reference (TYPE) | GUID_32 | GUID in 'CHAR' Format in Uppercase | 20060221 | |||
| 2 | R_FLAG | Value transfer | Type reference (TYPE) | CFX_BOOLEAN | abap_true if ecn s released | 20060221 |
Method IS_ECN_RELEASED on class CL_CFX_ECN_HLP has no exception.
Method IS_OBJ_ATTACHABLE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_OBJ_ID | Call by reference | Type reference (TYPE) | GUID_32 | GUID in 'CHAR' Format in Uppercase | 20060217 | |||
| 2 | R_FLAG | Value transfer | Type reference (TYPE) | CFX_BOOLEAN | Boolean Type | 20060217 |
Method IS_OBJ_ATTACHABLE on class CL_CFX_ECN_HLP has no exception.
Method IS_OBJ_ATTACHED_TO_ECN Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | E_COL_ID | Value transfer | Type reference (TYPE) | GUID_32 | GUID in 'CHAR' Format in Uppercase | 20060609 | |||
| 2 | E_ECN_ID | Value transfer | Type reference (TYPE) | GUID_32 | GUID in 'CHAR' Format in Uppercase | 20060217 | |||
| 3 | E_FLAG | Value transfer | Type reference (TYPE) | CFX_BOOLEAN | Boolean Type | 20060217 | |||
| 4 | I_OBJ_ID | Call by reference | Type reference (TYPE) | GUID_32 | GUID in 'CHAR' Format in Uppercase | 20060217 |
Method IS_OBJ_ATTACHED_TO_ECN on class CL_CFX_ECN_HLP has no exception.
Method LOCK_ATT_OBJ Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_ECN_ID | Call by reference | Type reference (TYPE) | GUID_32 | GUID in 'CHAR' Format in Uppercase | 20060901 |
Method LOCK_ATT_OBJ on class CL_CFX_ECN_HLP has no exception.
Method LOCK_ECN Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_ECN_ID | Call by reference | Type reference (TYPE) | GUID_32 | GUID in 'CHAR' Format in Uppercase | 20061218 |
Method LOCK_ECN on class CL_CFX_ECN_HLP has no exception.
Method ON_OBJS_AFTER_DELETE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | SENDER | Value transfer | Attribute reference (LIKE) | 20060801 |
Method ON_OBJS_AFTER_DELETE on class CL_CFX_ECN_HLP has no exception.
Method ON_OBJS_BEFORE_COPY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | SENDER | Value transfer | Attribute reference (LIKE) | 20060804 |
Method ON_OBJS_BEFORE_COPY on class CL_CFX_ECN_HLP has no exception.
Method ON_OBJS_BEFORE_DELETE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | SENDER | Call by reference | Attribute reference (LIKE) | 20060808 |
Method ON_OBJS_BEFORE_DELETE on class CL_CFX_ECN_HLP has no exception.
Method ON_OBJS_VER_CREATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_NUMBER_OF_VERSIONS | Value transfer | Attribute reference (LIKE) | 20060609 | |||||
| 2 | SENDER | Value transfer | Attribute reference (LIKE) | 20060609 |
Method ON_OBJS_VER_CREATE on class CL_CFX_ECN_HLP has no exception.
Method RELEASE_ECN Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_ECN_ID | Call by reference | Type reference (TYPE) | GUID_32 | GUID in 'CHAR' Format in Uppercase | 20060127 | |||
| 2 | R_FLAG | Value transfer | Type reference (TYPE) | CFX_BOOLEAN | abap_false on failure | 20060220 |
Method RELEASE_ECN on class CL_CFX_ECN_HLP has no exception.
Method SEARCH_ECN_WITHOUT_TREX Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_ECN_LIST | Call by reference | Type reference (TYPE) | CFX_TT_ECN_LIST | 20060516 | ||||
| 2 | I_COL_ID | Call by reference | Type reference (TYPE) | STRING | 20060516 |
Method SEARCH_ECN_WITHOUT_TREX on class CL_CFX_ECN_HLP has no exception.
Method SEARCH_ECN_WITH_TREX Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_ECN_LIST | Call by reference | Type reference (TYPE) | CFX_TT_ECN_LIST | List of Generic Object type Objects, specifically for ECNs. | 20060516 | |||
| 2 | I_COL_ID | Call by reference | Type reference (TYPE) | STRING | 20060516 | ||||
| 3 | I_ROLE | Call by reference | Type reference (TYPE) | CFX_ROLE | Role of a CFX User | 20060518 |
Method SEARCH_ECN_WITH_TREX on class CL_CFX_ECN_HLP has no exception.
Method SELECT_ECNS_IN_COLLAB Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_ECN_LIST | Call by reference | Type reference (TYPE) | CFX_TT_ECN_LIST | List of Generic Object type Objects, specifically for ECNs. | 20060502 | |||
| 2 | I_COL_ID | Call by reference | Type reference (TYPE) | STRING | Collaboration ID | 20060424 | |||
| 3 | I_ROLE | Call by reference | Type reference (TYPE) | CFX_ROLE | Role of a CFX User | 20060424 |
Method SELECT_ECNS_IN_COLLAB on class CL_CFX_ECN_HLP has no exception.
Method UNLOCK_ATT_OBJ Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_ECN_ID | Call by reference | Type reference (TYPE) | GUID_32 | GUID in 'CHAR' Format in Uppercase | 20060901 |
Method UNLOCK_ATT_OBJ on class CL_CFX_ECN_HLP has no exception.
Method UNLOCK_ECN Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_ECN_ID | Call by reference | Type reference (TYPE) | GUID_32 | GUID in 'CHAR' Format in Uppercase | 20061218 |
Method UNLOCK_ECN on class CL_CFX_ECN_HLP has no exception.
History
| Last changed by/on | SAP | 20141109 |
| SAP Release Created in | 500 |