SAP ABAP Class CL_SRM_ECM_W_HIERARCHY_SERVICE (SRM_ECM : RM connector for ECM write operations)
Hierarchy
SAP_BASIS (Software Component) SAP Basis Component
   BC-SRV-RM (Application Component) SAP Records Management
     SRM_ECM_IMPL (Package) Records Management SPI (ECM) Implementation
Meta Relationship - Using
# Relationship type Using Short Description Created on
1 Interface implementation (CLASS c. INTERFACES i_ref)  IF_NWECM_SUBSERVICE ECMI: Basic Connector Service Interface 20090317
2 Interface implementation (CLASS c. INTERFACES i_ref)  IF_NWECM_W_HIERARCHY_SERVICE ECMI: Hierarchy service for write operations 20090317
Properties
Class CL_SRM_ECM_W_HIERARCHY_SERVICE  
Short Description SRM_ECM : RM connector for ECM write operations    
Super Class    
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status     
Category 0   
Package SRM_ECM_IMPL   Records Management SPI (ECM) Implementation 
Created 20090317   SAP 
Last change 20110908   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 IF_SRM Forward declaration interface (INTERFACE i DEFINITION DEF...  Forward declaration interface (INTERFACE i DEFINITION DEF...
3 IF_SRM_SP_RECORD Forward declaration interface (INTERFACE i DEFINITION DEF...  Forward declaration interface (INTERFACE i DEFINITION DEF...
4 IF_SRM_SP_RECORD_ELEMENT Forward declaration interface (INTERFACE i DEFINITION DEF...  Forward declaration interface (INTERFACE i DEFINITION DEF...
5 SRMGS Type group use (TYPE-POOLS tp)  Type group use (TYPE-POOLS tp)
Interfaces
# Interface Abstract Final Description Created on
1 IF_NWECM_SUBSERVICE ECMI: Basic Connector Service Interface 20090317
2 IF_NWECM_W_HIERARCHY_SERVICE ECMI: Hierarchy service for write operations 20090317
Friends
Class CL_SRM_ECM_W_HIERARCHY_SERVICE has no friend class.
Attributes
Class CL_SRM_ECM_W_HIERARCHY_SERVICE has no attribute.
Methods
# Method Level Visibility Method type Description Created on
1 APPLY_CONSTRAINT_NNT_INSERT Instance method Private Method Applies naming constraints to the new name & inserts in NNT 20090317
2 CHECK_MULTIPLE_LINK_EXISTS Static method Public Method Check whether multiple entries of doc exists under folder 20090515
3 CREATE_NEW_REC_ELEMENT Instance method Private Method Creates new record element object for a record 20090317
4 CREATE_RM_FILE Instance method Private Method To create document in KPRO 20090318
5 GET_MDL_DATA_4_CREATE Instance method Private Method SRM_ECM: Gets model node id for give record node id 20090903
6 GET_MDL_NODE_FROM_TARGET_FOLDR Instance method Private Method Retrieves the model and model node for a folder_info 20090903
7 GET_NODE_DATA_4_CREATE Instance method Public Method Creates a new file inside the given folder 20090903
8 GET_RM_ATTR Instance method Private Method To Get RM Attributes 20090330
9 IDENTIFY_ADD_TO_TRGT_MODL_NODE Instance method Private Method SRM_ECM: Gets model node id for give record node id 20090421
10 INTERNAL_COPY Instance method Private Method Copies the file to the target folder 20090317
11 INTERNAL_CREATE Instance method Private Method Creates a new file inside the given folder 20090915
12 IS_DOC_CREATE_ALLOWED Instance method Private Method To check whether doc is allowed to create 20090424
13 MOVE_LINK Instance method Private Method Delete the link from source folder and create new at target 20090413
14 MOVE_RM_LINK Instance method Private Method Moves the document link within RM objects [ Record/Case ] 20090325
15 MOVE_WITHIN_FAV Instance method Private Method Move when both the source and target are under FAV 20090330
16 REMOVE_MATCHED_INSTANCE Static method Public Method Remove the link of the document under source folder 20090413
Events
Class CL_SRM_ECM_W_HIERARCHY_SERVICE has no event.
Types
Class CL_SRM_ECM_W_HIERARCHY_SERVICE has no local type.
Method Signatures

Method APPLY_CONSTRAINT_NNT_INSERT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CO_SOURCE_NODE_INFO Call by reference Object reference (TYPE REF TO) CL_SRM_ECM_NODE_INFO NW ECM: Connector-Specific Node Info 20090317
2 Importing IO_SESSION_INFO Call by reference Object reference (TYPE REF TO) IF_NWECM_SESSION_INFO NW ECM: Session Info for User and Workspace Identification 20090318
3 Importing IV_NEW_NAME Call by reference Type reference (TYPE) STRING 20090319
4 Exporting OT_RETURN Call by reference Type reference (TYPE) BAPIRET2_T Return parameter table 20090317
# Exception Resumable Description Created on
1 CX_SRM_ECM_APPL_LOG Application Log of SRM ECM 20090317

Method CHECK_MULTIPLE_LINK_EXISTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_RECORD_API Call by reference Object reference (TYPE REF TO) IF_SRM_SP_RECORD IF_SRM_SP_RECORD 20090515
2 Importing IO_SESSION_INFO Call by reference Object reference (TYPE REF TO) IF_NWECM_SESSION_INFO NW ECM: Session Info for User and Workspace Identification 20090515
3 Importing IO_SOURCE_NODE_INFO Call by reference Object reference (TYPE REF TO) IF_NWECM_NODE_INFO NW ECM: Connector-Specific Node Info 20090515
4 Importing IV_NODE_RUNTIME_ID Call by reference Type reference (TYPE) STRING IF_SRM_SP_RECORD=>ID_ROOT 20090515
5 Exporting OT_RETURN Call by reference Type reference (TYPE) BAPIRET2_T Return parameter table 20090515
# Exception Resumable Description Created on
1 CX_SRM_ECM_APPL_LOG Application Log of SRM ECM 20090515

Method CREATE_NEW_REC_ELEMENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_RECORD Call by reference Object reference (TYPE REF TO) IF_SRM_SP_RECORD IF_SRM_SP_RECORD 20090317
2 Importing IO_SOURCE_NODE_POID Call by reference Object reference (TYPE REF TO) CL_SRM_POID POID 20090317
3 Importing IV_SOURCE_NODE_NAME Call by reference Type reference (TYPE) STRING 20090319
4 Importing IV_SOURCE_NODE_TYPE Call by reference Type reference (TYPE) STRING IF_SRM_SP_RECORD_ELEMENT=>TYPE_INSTANCE 20090319
5 Exporting OO_RECORD_ELEMENT Call by reference Object reference (TYPE REF TO) IF_SRM_SP_RECORD_ELEMENT IF_SRM_SP_RECORD_ELEMENT 20090317
6 Exporting OT_RETURN Call by reference Type reference (TYPE) BAPIRET2_T Return parameter table 20090317
# Exception Resumable Description Created on
1 CX_SRM_ECM_APPL_LOG Application Log of SRM ECM 20090317

Method CREATE_RM_FILE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_PARENT_INFO Call by reference Object reference (TYPE REF TO) IF_NWECM_FOLDER_INFO Parent node information 20090318
2 Importing IO_SESSION_INFO Call by reference Object reference (TYPE REF TO) IF_NWECM_SESSION_INFO session information 20090318
3 Importing IT_PROPERTIES Call by reference Type reference (TYPE) NWECM_T_PROPERTY_HOLDER document properties 20090318
4 Importing IV_CONTENT Call by reference Type reference (TYPE) XSTRING document content 20090318
5 Importing IV_HIS_ENTRY Call by reference Type reference (TYPE) SRMBOOLEAN IF_SRM=>FALSE an entry into history 20090318
6 Importing IV_MIMETYPE Call by reference Type reference (TYPE) STRING mime type of document 20090318
7 Importing IV_NAME Call by reference Type reference (TYPE) STRING name of the document 20090318
8 Importing IV_SPS_ID Call by reference Type reference (TYPE) STRING node sps id 20090318
9 Exporting OO_FILE_INFO Value transfer Object reference (TYPE REF TO) IF_NWECM_FILE_INFO new document information 20090318
10 Exporting OT_RETURN Call by reference Type reference (TYPE) BAPIRET2_T application log messages 20090318
# Exception Resumable Description Created on
1 CX_SRM_ECM_APPL_LOG Application Log of SRM ECM 20090318

Method GET_MDL_DATA_4_CREATE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_RECORD_MODEL Call by reference Object reference (TYPE REF TO) IF_SRM_SP_MODEL Record model for target folder 20090903
2 Importing IO_SESSION_INFO Call by reference Object reference (TYPE REF TO) IF_NWECM_SESSION_INFO Session Information 20090903
3 Importing IV_TARGET_MODELID Call by reference Type reference (TYPE) STRING Model ID of target (structure) node for doc creation 20090903
4 Exporting OT_RETURN Call by reference Type reference (TYPE) BAPIRET2_T Return parameter table 20090903
5 Exporting OV_SPS_ID_4_CREATE Call by reference Type reference (TYPE) STRING SPS ID for new document 20090903
6 Exporting OV_TARGET_MODELID Call by reference Type reference (TYPE) STRING ID of target model node for new document 20090903
# Exception Resumable Description Created on
1 CX_SRM_ECM_APPL_LOG Application Log of SRM ECM 20090903

Method GET_MDL_NODE_FROM_TARGET_FOLDR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_SESSION_INFO Value transfer Object reference (TYPE REF TO) IF_NWECM_SESSION_INFO Session information 20090903
2 Importing IO_TARGET_FOLDER_INFO Value transfer Object reference (TYPE REF TO) IF_NWECM_FOLDER_INFO The target folder where the new file should be created 20090903
3 Exporting OO_RECORD_API Call by reference Object reference (TYPE REF TO) IF_SRM_SP_RECORD API for record / case record 20090914
4 Exporting OO_RECORD_MODEL Call by reference Object reference (TYPE REF TO) IF_SRM_SP_MODEL Target record / case model 20090903
5 Exporting OT_RETURN Call by reference Type reference (TYPE) BAPIRET2_T Return parameter table 20090903
6 Exporting OV_TARGET_MODELID Call by reference Type reference (TYPE) STRING Model node ID of target folder 20090903
# Exception Resumable Description Created on
1 CX_SRM_ECM_APPL_LOG Application Log of SRM ECM 20090903

Method GET_NODE_DATA_4_CREATE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_SESSION_INFO Value transfer Object reference (TYPE REF TO) IF_NWECM_SESSION_INFO Session information 20090903
2 Importing IO_TARGET_FOLDER_INFO Value transfer Object reference (TYPE REF TO) IF_NWECM_FOLDER_INFO The target folder where the new file should be created 20090903
3 Exporting OO_RECORD_API Call by reference Object reference (TYPE REF TO) IF_SRM_SP_RECORD API for record / case record 20090914
4 Exporting OT_RETURN Call by reference Type reference (TYPE) BAPIRET2_T Return parameter table 20090903
5 Exporting OV_MODEL_NODE_4_CREATE Call by reference Type reference (TYPE) STRING ID of the model node for file creation 20090903
6 Exporting OV_SPS_ID_4_CREATE Call by reference Type reference (TYPE) STRING Element type for file creation 20090903
# Exception Resumable Description Created on
1 CX_SRM_ECM_APPL_LOG Application Log of SRM ECM 20090903

Method GET_RM_ATTR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_SESSION_INFO Call by reference Object reference (TYPE REF TO) IF_NWECM_SESSION_INFO NW ECM: Session Info for User and Workspace Identification 20090330
2 Importing IO_SRM_POID Call by reference Object reference (TYPE REF TO) IF_SRM_POID POID 20090330
3 Importing IV_NAME Call by reference Type reference (TYPE) STRING 20090330
4 Exporting OT_LOIO_PROPS Call by reference Type reference (TYPE) SRMGS_PROPERTY_TAB 20090330
5 Exporting OT_PHIO_PROPS Call by reference Type reference (TYPE) SRMGS_PROPERTY_TAB 20090330
6 Exporting OT_RETURN Call by reference Type reference (TYPE) BAPIRET2_T Return parameter table 20090330
# Exception Resumable Description Created on
1 CX_SRM_ECM_APPL_LOG Application Log of SRM ECM 20090330

Method IDENTIFY_ADD_TO_TRGT_MODL_NODE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_RECORD_API Call by reference Object reference (TYPE REF TO) IF_SRM_SP_RECORD Record API for target folder 20090421
2 Importing IO_RECORD_ELEMENT Call by reference Object reference (TYPE REF TO) IF_SRM_SP_RECORD_ELEMENT record element of source node 20090421
3 Importing IO_SERVICE Call by reference Object reference (TYPE REF TO) IF_SRM_SRM_SERVICE SRM Service 20090421
4 Importing IS_SOURCE_NNT Call by reference Type reference (TYPE) SRM_ECM_NNT Lookup table for RM node names in ECM integration 20090421
5 Importing I_TARGET_REC_NODE_ID Call by reference Type reference (TYPE) STRING Node If of target record 20090421
6 Exporting OT_RETURN Call by reference Type reference (TYPE) BAPIRET2_T Return parameter table 20090421
7 Exporting OV_NODE_ID Call by reference Type reference (TYPE) STRING Node if of copied node 20090421
# Exception Resumable Description Created on
1 CX_SRM_ECM_APPL_LOG Application Log of SRM ECM 20090421

Method INTERNAL_COPY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_SESSION_INFO Call by reference Object reference (TYPE REF TO) IF_NWECM_SESSION_INFO NW ECM: Session Info for User and Workspace Identification 20090317
2 Importing IO_SOURCE_NODE_INFO Call by reference Object reference (TYPE REF TO) IF_NWECM_NODE_INFO NW ECM: Connector-Specific Node Info 20090317
3 Importing IO_TARGET_FOLDER_INFO Call by reference Object reference (TYPE REF TO) IF_NWECM_FOLDER_INFO NW ECM: Connector-Specific Folder Info 20090317
4 Importing IV_NEW_NAME Call by reference Type reference (TYPE) STRING new name of source node in target folder 20090317
5 Importing IV_OVERWRITE Value transfer Type reference (TYPE) ABAP_BOOL ABAP_FALSE indicates request to replace node with same name in target 20090317
6 Exporting OT_RETURN Call by reference Type reference (TYPE) BAPIRET2_T Return parameter table 20090317
7 Exporting OV_NODE_ID Call by reference Type reference (TYPE) STRING ID of the copied node 20090317
# Exception Resumable Description Created on
1 CX_SRM_ECM_APPL_LOG Application Log of SRM ECM 20090317

Method INTERNAL_CREATE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_PARENT_INFO Value transfer Object reference (TYPE REF TO) IF_NWECM_FOLDER_INFO The parent folder where the new file should be created 20090915
2 Importing IO_SESSION_INFO Value transfer Object reference (TYPE REF TO) IF_NWECM_SESSION_INFO Session information 20090915
3 Importing IT_PROPERTIES Call by reference Type reference (TYPE) NWECM_T_PROPERTY_HOLDER Table of property info type 20090915
4 Importing IV_CONTENT Call by reference Type reference (TYPE) XSTRING The content as xstring 20090915
5 Importing IV_MIME_TYPE Value transfer Type reference (TYPE) STRING 20090915
6 Importing IV_NAME Value transfer Type reference (TYPE) STRING 20090915
7 Importing IV_SIZE Value transfer Type reference (TYPE) NWECM_LONG Lenght of a file in bytes 20090915
8 Exporting OO_FILE_INFO Value transfer Object reference (TYPE REF TO) IF_NWECM_FILE_INFO The newly created file 20090915
9 Exporting OT_RETURN Call by reference Type reference (TYPE) BAPIRET2_T Return parameter table 20090915
# Exception Resumable Description Created on
1 CX_SRM_ECM_APPL_LOG Application Log of SRM ECM 20090915

Method IS_DOC_CREATE_ALLOWED Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_DOC_POID Call by reference Object reference (TYPE REF TO) IF_SRM_POID doc poid 20090424
2 Exporting OT_RETURN Call by reference Type reference (TYPE) BAPIRET2_T log entries 20090424
3 Exporting OV_DOC_CREATE Call by reference Type reference (TYPE) SRMBOOLEAN is doc create allowed 20090424
# Exception Resumable Description Created on
1 CX_SRM_ECM_APPL_LOG Application Log of SRM ECM 20090424

Method MOVE_LINK Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_RECORD_API Call by reference Object reference (TYPE REF TO) IF_SRM_SP_RECORD IF_SRM_SP_RECORD 20090413
2 Importing IO_SESSION_INFO Call by reference Object reference (TYPE REF TO) IF_NWECM_SESSION_INFO NW ECM: Session Info for User and Workspace Identification 20090413
3 Importing IO_SOURCE_NODE_INFO Call by reference Object reference (TYPE REF TO) IF_NWECM_NODE_INFO POID 20090413
4 Importing IO_TARGET_FOLDER_INFO Call by reference Object reference (TYPE REF TO) IF_NWECM_FOLDER_INFO NW ECM: Connector-Specific Folder Info 20090413
5 Importing IV_NEW_NAME Call by reference Type reference (TYPE) STRING 20090413
6 Importing IV_NODE_RUNTIME_ID Call by reference Type reference (TYPE) STRING IF_SRM_SP_RECORD=>ID_ROOT 20090413
7 Importing IV_OVERWRITE Call by reference Type reference (TYPE) ABAP_BOOL 20090413
8 Exporting OT_RETURN Call by reference Type reference (TYPE) BAPIRET2_T Return parameter table 20090413
9 Exporting OV_NODE_ID Call by reference Type reference (TYPE) STRING 20090413
# Exception Resumable Description Created on
1 CX_SRM_ECM_APPL_LOG Application Log of SRM ECM 20090413

Method MOVE_RM_LINK Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_SESSION_INFO Call by reference Object reference (TYPE REF TO) IF_NWECM_SESSION_INFO NW ECM: Session Info for User and Workspace Identification 20090325
2 Importing IO_SOURCE_FOLDER_INFO Call by reference Object reference (TYPE REF TO) IF_NWECM_FOLDER_INFO NW ECM: Connector-Specific Folder Info 20090325
3 Importing IO_SOURCE_NODE_INFO Call by reference Object reference (TYPE REF TO) IF_NWECM_NODE_INFO NW ECM: Connector-Specific Node Info 20090325
4 Importing IO_TARGET_FOLDER_INFO Call by reference Object reference (TYPE REF TO) IF_NWECM_FOLDER_INFO NW ECM: Connector-Specific Folder Info 20090325
5 Importing IV_NEW_NAME Call by reference Type reference (TYPE) STRING 20090325
6 Importing IV_OVERWRITE Call by reference Type reference (TYPE) ABAP_BOOL 20090325
7 Exporting OT_RETURN Call by reference Type reference (TYPE) BAPIRET2_T Return parameter table 20090325
8 Exporting OV_ID Call by reference Type reference (TYPE) STRING 20090325
# Exception Resumable Description Created on
1 CX_SRM_ECM_APPL_LOG Application Log of SRM ECM 20090325

Method MOVE_WITHIN_FAV Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_SESSION_INFO Call by reference Object reference (TYPE REF TO) IF_NWECM_SESSION_INFO NW ECM: Session Info for User and Workspace Identification 20090330
2 Importing IO_SOURCE_FOLDER_INFO Call by reference Object reference (TYPE REF TO) IF_NWECM_FOLDER_INFO NW ECM: Connector-Specific Folder Info 20090330
3 Importing IO_SOURCE_NODE_INFO Call by reference Object reference (TYPE REF TO) IF_NWECM_NODE_INFO NW ECM: Connector-Specific Node Info 20090330
4 Importing IO_TARGET_FOLDER_INFO Call by reference Object reference (TYPE REF TO) IF_NWECM_FOLDER_INFO NW ECM: Connector-Specific Folder Info 20090330
5 Importing IV_NEW_NAME Call by reference Type reference (TYPE) STRING 20090330
6 Importing IV_OVERWRITE Call by reference Type reference (TYPE) ABAP_BOOL 20090330
7 Exporting OT_RETURN Call by reference Type reference (TYPE) BAPIRET2_T Return parameter table 20090330
8 Exporting OV_ID Call by reference Type reference (TYPE) STRING 20090330
# Exception Resumable Description Created on
1 CX_SRM_ECM_APPL_LOG Application Log of SRM ECM 20090330

Method REMOVE_MATCHED_INSTANCE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_RECORD_API Call by reference Object reference (TYPE REF TO) IF_SRM_SP_RECORD IF_SRM_SP_RECORD 20090413
2 Importing IO_SESSION_INFO Call by reference Object reference (TYPE REF TO) IF_NWECM_SESSION_INFO NW ECM: Session Info for User and Workspace Identification 20090413
3 Importing IO_SOURCE_NODE_INFO Call by reference Object reference (TYPE REF TO) IF_NWECM_NODE_INFO NW ECM: Connector-Specific Node Info 20090413
4 Importing IV_NODE_RUNTIME_ID Call by reference Type reference (TYPE) STRING IF_SRM_SP_RECORD=>ID_ROOT 20090413
5 Exporting OO_RECORD_ELEMENT_MATCH Call by reference Object reference (TYPE REF TO) IF_SRM_SP_RECORD_ELEMENT IF_SRM_SP_RECORD_ELEMENT 20090413
6 Exporting OT_RETURN Call by reference Type reference (TYPE) BAPIRET2_T Return parameter table 20090413
# Exception Resumable Description Created on
1 CX_SRM_ECM_APPL_LOG Application Log of SRM ECM 20090413
History
Last changed by/on SAP  20110908 
SAP Release Created in 720