SAP ABAP Interface IF_NWECM_HIERARCHY_SERVICE (ECMI: Service for Hierarchical Node Organization)
Hierarchy
SAP_BASIS (Software Component) SAP Basis Component
   BC-ECM-ABA-COR (Application Component) ECM Core Infrastructure
     S_NWECM_SPI (Package) Service Provider Interface for ECMI
Meta Relationship - Used By
# Relationship type Used by Short Description Created on
1 Interface implementation (CLASS c. INTERFACES i_ref)  CL_CMIS10_HIERARCHY_SRV Simple ECM connector hierarchy service 20100519
2 Interface implementation (CLASS c. INTERFACES i_ref)  CL_NWECM_HIERARCHY_FS ECMI: Fileshare Hierarchy Service implementation 20100414
3 Interface implementation (CLASS c. INTERFACES i_ref)  CL_NWECM_HIERARCHY_SERVICE_SWR ECMI: Hierarchy Service SPI Firewall Wrapper 20080731
4 Interface implementation (CLASS c. INTERFACES i_ref)  CL_NWECM_HIERARCHY_SRV_STUB NW ECM: Configurable Hierarchy Service Stub 20081010
5 Interface implementation (CLASS c. INTERFACES i_ref)  CL_NWECM_PLC_HIERARCHY_SRV ECMI: Hierarchy Service implementation 20090504
6 Interface implementation (CLASS c. INTERFACES i_ref)  CL_NWECM_WD_HIERARCHY_SERVICE WebDAV connector hierarchy service 20090108
7 Interface implementation (CLASS c. INTERFACES i_ref)  CL_SRM_ECM_HIERARCHY_SERVICE NW ECM: RM Hierarchy Service 20081007
Properties
Interface IF_NWECM_HIERARCHY_SERVICE  
Short Description ECMI: Service for Hierarchical Node Organization    
General Data
Package S_NWECM_SPI   Service Provider Interface for ECMI 
Created 20080722   SAP 
Last changed 20110908   SAP 
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)
Interfaces
# Interface Abstract Final Description Created on
1 IF_NWECM_SUBSERVICE ECMI: Basic Connector Service Interface 20080722
Friends
Interface IF_NWECM_HIERARCHY_SERVICE has no friend.
Attributes
Interface IF_NWECM_HIERARCHY_SERVICE has no attribute.
Methods
# Method Level Visibility Method type Description Created on
1 GET_CHILD Instance method Public Method Gets a named child of a folder 20080730
2 GET_CHILDREN Instance method Public Method Gets the children of a folder 20080729
3 GET_CHILDREN_RANGED Instance method Public Method Gets the children of a folder 20080813
4 GET_NODE Instance method Public Method Gets a node with an absolute path 20080729
5 GET_NUMBER_OF_CHILDREN Instance method Public Method Gets the number of children of a folder 20080722
6 GET_PARENT Instance method Public Method Gets the parent of a folder 20080722
7 GET_PATH Instance method Public Method Gets the path for a node 20080722
8 GET_ROOT_NODE Instance method Public Method Gets the root node 20080729
Events
Interface IF_NWECM_HIERARCHY_SERVICE has no event.
Types
Interface IF_NWECM_HIERARCHY_SERVICE has no local type.
Method Signatures

Method GET_CHILD Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_FOLDER_INFO Value transfer Object reference (TYPE REF TO) IF_NWECM_FOLDER_INFO NW ECM: Connector-Specific Folder Information 20080730
2 Importing IO_SESSION_INFO Value transfer Object reference (TYPE REF TO) IF_NWECM_SESSION_INFO used for user and workspace identification 20080730
3 Importing IT_PREPARE_FOR_PROPERTIES Call by reference Type reference (TYPE) NWECM_T_NAME 20081203
4 Importing IV_CHILD_NAME Value transfer Type reference (TYPE) STRING Name of the desired child 20080730
5 Importing IV_PREPARE_FOR_CONTENT Value transfer Type reference (TYPE) ABAP_BOOL ABAP_FALSE 20081203
6 Returning RO_CHILD_INFO Value transfer Object reference (TYPE REF TO) IF_NWECM_NODE_INFO Child node 20080730
# Exception Resumable Description Created on
1 CX_NWECM_ACCESS_DENIED NW ECM: Access Denied Exception 20081031
2 CX_NWECM_INVALID_STATE NW ECM: Invalid State Exception 20081008
3 CX_NWECM_NODE_NOT_FOUND NW ECM: Node Not Found 20080730
4 CX_NWECM_REPOSITORY NW ECM Repository Exception 20080730
5 CX_NWECM_UNSUPPORTED_OPERATION 20081218

Method GET_CHILDREN Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_FOLDER_INFO Value transfer Object reference (TYPE REF TO) IF_NWECM_FOLDER_INFO NW ECM: Connector-Specific Folder Information 20080729
2 Importing IO_SESSION_INFO Value transfer Object reference (TYPE REF TO) IF_NWECM_SESSION_INFO used for user and workspace identification 20080729
3 Importing IT_PREPARE_FOR_PROPERTIES Call by reference Type reference (TYPE) NWECM_T_NAME 20081203
4 Importing IV_PREPARE_FOR_CONTENT Value transfer Type reference (TYPE) ABAP_BOOL ABAP_FALSE 20081203
5 Returning RT_CHILD_INFOS Value transfer Type reference (TYPE) NWECM_T_NODE_INFO Table containing node references 20080729
# Exception Resumable Description Created on
1 CX_NWECM_ACCESS_DENIED NW ECM: Access Denied Exception 20081031
2 CX_NWECM_INVALID_STATE NW ECM: Node Not Found 20081008
3 CX_NWECM_REPOSITORY NW ECM Repository Exception 20080729

Method GET_CHILDREN_RANGED Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_FOLDER_INFO Value transfer Object reference (TYPE REF TO) IF_NWECM_FOLDER_INFO NW ECM: Connector-Specific Folder Information 20080813
2 Importing IO_SESSION_INFO Value transfer Object reference (TYPE REF TO) IF_NWECM_SESSION_INFO used for user and workspace identification 20080813
3 Importing IO_SORT_PROPERTY Value transfer Object reference (TYPE REF TO) CL_NWECM_NAME Implementation of name interface 20080813
4 Importing IT_PREPARE_FOR_PROPERTIES Call by reference Type reference (TYPE) NWECM_T_NAME 20081203
5 Importing IV_ASCENDING Value transfer Type reference (TYPE) ABAP_BOOL ABAP_UNDEFINED Sort Ascending 20080813
6 Importing IV_FROM Value transfer Type reference (TYPE) I 20080813
7 Importing IV_PREPARE_FOR_CONTENT Value transfer Type reference (TYPE) ABAP_BOOL ABAP_FALSE 20081203
8 Importing IV_TO Value transfer Type reference (TYPE) I 20080813
9 Returning RT_CHILD_INFOS Value transfer Type reference (TYPE) NWECM_T_NODE_INFO Table containing node references 20080813
# Exception Resumable Description Created on
1 CX_NWECM_ACCESS_DENIED NW ECM: Access Denied Exception 20081031
2 CX_NWECM_INVALID_STATE NW ECM: Node Not Found 20081008
3 CX_NWECM_REPOSITORY NW ECM Repository Exception 20080813
4 CX_NWECM_UNSUPPORTED_OPERATION NW ECM: Unsupported Repository Operation Exception 20080813

Method GET_NODE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_PATH Value transfer Object reference (TYPE REF TO) CL_NWECM_PATH defines the qualified representation of a path 20080729
2 Importing IO_SESSION_INFO Value transfer Object reference (TYPE REF TO) IF_NWECM_SESSION_INFO used for user and workspace identification 20080729
3 Importing IT_PREPARE_FOR_PROPERTIES Call by reference Type reference (TYPE) NWECM_T_NAME 20081203
4 Importing IV_PREPARE_FOR_CONTENT Value transfer Type reference (TYPE) ABAP_BOOL ABAP_FALSE 20081203
5 Returning RO_NODE_INFO Value transfer Object reference (TYPE REF TO) IF_NWECM_NODE_INFO rovides the basic information required to build nodes 20080729
# Exception Resumable Description Created on
1 CX_NWECM_ACCESS_DENIED NW ECM: Access Denied Exception 20081031
2 CX_NWECM_NODE_NOT_FOUND NW ECM Node or Property Not Found Exception 20080729
3 CX_NWECM_REPOSITORY NW ECM: Repository Exception 20080729
4 CX_NWECM_UNSUPPORTED_OPERATION NW ECM: Unsupported Repository Operation Exception 20080729

Method GET_NUMBER_OF_CHILDREN Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_FOLDER_INFO Value transfer Object reference (TYPE REF TO) IF_NWECM_FOLDER_INFO NW ECM: Connector-Specific Folder Information 20080722
2 Importing IO_SESSION_INFO Value transfer Object reference (TYPE REF TO) IF_NWECM_SESSION_INFO used for user and workspace identification 20080722
3 Returning RV_NUMBER_OF_CHILDREN Value transfer Type reference (TYPE) I Returns the Number of Children 20080731
# Exception Resumable Description Created on
1 CX_NWECM_ACCESS_DENIED NW ECM: Access Denied Exception 20081031
2 CX_NWECM_INVALID_STATE NW ECM: Node Not Found 20081008
3 CX_NWECM_REPOSITORY NW ECM Repository Exception 20080722

Method GET_PARENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_NODE_INFO Value transfer Object reference (TYPE REF TO) IF_NWECM_NODE_INFO 20081104
2 Importing IO_SESSION_INFO Value transfer Object reference (TYPE REF TO) IF_NWECM_SESSION_INFO used for user and workspace identification 20080731
3 Importing IT_PREPARE_FOR_PROPERTIES Call by reference Type reference (TYPE) NWECM_T_NAME 20081203
4 Returning RO_PARENT_INFO Value transfer Object reference (TYPE REF TO) IF_NWECM_FOLDER_INFO NW ECM: Connector-Specific Folder Information 20080729
# Exception Resumable Description Created on
1 CX_NWECM_ACCESS_DENIED NW ECM: Access Denied Exception 20081031
2 CX_NWECM_INVALID_STATE NW ECM: Node Not Found 20081008
3 CX_NWECM_REPOSITORY NW ECM Repository Exception 20080722

Method GET_PATH Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_NODE_INFO Value transfer Object reference (TYPE REF TO) IF_NWECM_NODE_INFO 20081104
2 Importing IO_SESSION_INFO Value transfer Object reference (TYPE REF TO) IF_NWECM_SESSION_INFO used for user and workspace identification 20080731
3 Returning RO_PATH Value transfer Object reference (TYPE REF TO) CL_NWECM_PATH NW ECM: Path Representation and Handling 20080722
# Exception Resumable Description Created on
1 CX_NWECM_ACCESS_DENIED NW ECM: Access Denied Exception 20081031
2 CX_NWECM_INVALID_STATE NW ECM: Node Not Found 20081008
3 CX_NWECM_REPOSITORY NW ECM Repository Exception 20080722

Method GET_ROOT_NODE 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 used for user and workspace identification 20080729
2 Returning RO_ROOT_NODE_INFO Value transfer Object reference (TYPE REF TO) IF_NWECM_FOLDER_INFO Returns the Root Folder 20080729
# Exception Resumable Description Created on
1 CX_NWECM_ACCESS_DENIED NW ECM: Access Denied Exception 20081031
2 CX_NWECM_REPOSITORY NW ECM Repository Exception 20080729
History
Last changed by/on SAP  20110908 
SAP Release Created in 712