SAP ABAP Interface IF_NWECM_FOLDER (ECMI: Folder Type Node)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-ECM-ABA-COR (Application Component) ECM Core Infrastructure
⤷
S_NWECM_API_ITEM (Package) ECMI: Nodes, Properties and Related Classes
SAP_BASIS (Software Component) SAP Basis Component⤷
BC-ECM-ABA-COR (Application Component) ECM Core Infrastructure⤷
S_NWECM_API_ITEM (Package) ECMI: Nodes, Properties and Related Classes
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_NWECM_FOLDER | ECMI: Folder Implementation | 20080729 |
| 2 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_NWECM_FOLDER_AWR | ECMI: Folder API Firewall Wrapper | 20080729 |
Properties
| Interface | IF_NWECM_FOLDER | |
| Short Description | ECMI: Folder Type Node |
General Data
| Package | S_NWECM_API_ITEM | ECMI: Nodes, Properties and Related Classes |
| Created | 20080529 | 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_NODE | ECMI: Generic Node | 20080721 |
Friends
Interface IF_NWECM_FOLDER has no friend.
Attributes
Interface IF_NWECM_FOLDER has no attribute.
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CREATE_FILE |
Instance method | Public | Method | Creates a new child file within this folder | 20081015 |
| 2 | CREATE_FOLDER |
Instance method | Public | Method | Creates a new child folder within this folder | 20080923 |
| 3 | GET_CHILD |
Instance method | Public | Method | Gets a named child within this folder | 20080731 |
| 4 | GET_CHILDREN |
Instance method | Public | Method | Gets all children within this folder | 20080721 |
| 5 | GET_NUMBER_OF_CHILDREN |
Instance method | Public | Method | Gets the number of children within this folder | 20080721 |
Events
Interface IF_NWECM_FOLDER has no event.
Types
Interface IF_NWECM_FOLDER has no local type.
Method Signatures
Method CREATE_FILE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IO_STORAGE_CLASS | Value transfer | Object reference (TYPE REF TO) | CL_NWECM_STORAGE_CLASS | Storage class of the new file | 20090812 | ||
| 2 | Importing |
IT_PROPERTIES | Call by reference | Type reference (TYPE) | NWECM_T_NAME_VALUES | Table of properties | 20081015 | ||
| 3 | Importing |
IV_CONTENT | Call by reference | Type reference (TYPE) | XSTRING | The content as xstring | 20081015 | ||
| 4 | Importing |
IV_MIME_TYPE | Value transfer | Type reference (TYPE) | STRING | Mimetype of the file's content | 20081015 | ||
| 5 | Importing |
IV_NAME | Value transfer | Type reference (TYPE) | STRING | name of the file | 20081202 | ||
| 6 |  Returning |
RO_FILE | Value transfer | Object reference (TYPE REF TO) | IF_NWECM_FILE | The newly created file | 20081015 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_NWECM_ACCESS_DENIED |
NW ECM: Access Denied Exception | 20081015 | |
| 2 | CX_NWECM_CONSTRAINT_VIOLATION |
20090513 | ||
| 3 | CX_NWECM_ILLEGAL_ARGUMENT |
NW ECM: Illegal Argument Exception | 20090225 | |
| 4 | CX_NWECM_INVALID_STATE |
NW ECM: Invalid State Exception | 20081015 | |
| 5 | CX_NWECM_ITEM_EXISTS |
NW ECM: Item Already Exists Exception | 20081015 | |
| 6 | CX_NWECM_LOCK |
NW ECM: Lock Exception | 20081015 | |
| 7 | CX_NWECM_REPOSITORY |
NW ECM: Repository Exception | 20081015 | |
| 8 | CX_NWECM_UNSUPPORTED_OPERATION |
NW ECM: Unsupported Repository Operation Exception | 20081015 |
Method CREATE_FOLDER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IO_STORAGE_CLASS | Value transfer | Object reference (TYPE REF TO) | CL_NWECM_STORAGE_CLASS | Storage class of the new folder | 20090812 | ||
| 2 | Importing |
IT_PROPERTIES | Call by reference | Type reference (TYPE) | NWECM_T_NAME_VALUES | NW ECM: Table of structure NWECM_S_NAME_VALUES | 20090714 | ||
| 3 | Importing |
IV_NAME | Value transfer | Type reference (TYPE) | STRING | The name of the new folder | 20081202 | ||
| 4 | Returning |
RO_FOLDER | Value transfer | Object reference (TYPE REF TO) | IF_NWECM_FOLDER | The newly created folder | 20081007 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_NWECM_ACCESS_DENIED |
NW ECM: Access Denied Exception | 20080923 | |
| 2 | CX_NWECM_CONSTRAINT_VIOLATION |
20090513 | ||
| 3 | CX_NWECM_ILLEGAL_ARGUMENT |
NW ECM: Illegal Argument Exception | 20090225 | |
| 4 | CX_NWECM_INVALID_STATE |
NW ECM: Invalid State Exception | 20080923 | |
| 5 | CX_NWECM_ITEM_EXISTS |
NW ECM: Item Already Exists Exception | 20080923 | |
| 6 | CX_NWECM_LOCK |
NW ECM: Lock Exception | 20080923 | |
| 7 | CX_NWECM_REPOSITORY |
NW ECM: Repository Exception | 20080923 | |
| 8 | CX_NWECM_UNSUPPORTED_OPERATION |
NW ECM: Unsupported Repository Operation Exception | 20080923 |
Method GET_CHILD Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IT_PREPARE_FOR_PROPERTIES | Call by reference | Type reference (TYPE) | NWECM_T_NAME | The named properties are needed afterwards | 20081203 | ||
| 2 | Importing |
IV_CHILD_NAME | Value transfer | Type reference (TYPE) | STRING | Name of the desired child | 20080731 | ||
| 3 | Importing |
IV_PREPARE_FOR_CONTENT | Value transfer | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | The content information is needed afterwards | 20081203 | |
| 4 | Returning |
RO_CHILD | Value transfer | Object reference (TYPE REF TO) | IF_NWECM_NODE | The child node | 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_NODE_NOT_FOUND |
NW ECM: Node Not Found Exception | 20081008 | |
| 4 | CX_NWECM_REPOSITORY |
NW ECM Repository Exception | 20080731 |
Method GET_CHILDREN Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IO_SORT_PROPERTY | Value transfer | Object reference (TYPE REF TO) | CL_NWECM_NAME | Defines a sort property | 20080813 | ||
| 2 | Importing |
IT_PREPARE_FOR_PROPERTIES | Call by reference | Type reference (TYPE) | NWECM_T_NAME | The named properties are needed afterwards | 20081203 | ||
| 3 | Importing |
IV_ASCENDING | Value transfer | Type reference (TYPE) | ABAP_BOOL | ABAP_UNDEFINED | If true the sorting will be ascending | 20080813 | |
| 4 | Importing |
IV_FROM | Value transfer | Type reference (TYPE) | I | Specify which elements should be contained in the returned t | 20080813 | ||
| 5 | Importing |
IV_PREPARE_FOR_CONTENT | Value transfer | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | The content information is needed afterwards | 20081203 | |
| 6 | Importing |
IV_TO | Value transfer | Type reference (TYPE) | I | Specify which elements should be contained in the returned t | 20080813 | ||
| 7 | Returning |
RT_CHILDREN | Value transfer | Type reference (TYPE) | NWECM_T_NODE | Table of children | 20080721 |
| # | 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 | 20080721 | |
| 4 | CX_NWECM_UNSUPPORTED_OPERATION |
NW ECM: Unsupported Repository Operation Exception | 20090204 |
Method GET_NUMBER_OF_CHILDREN Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RV_NUMBER_OF_CHILDREN | Value transfer | Type reference (TYPE) | I | The number of children. | 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 | 20080721 |
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in | 712 |
