SAP ABAP Class CL_SRM_ECM_FILE_INFO (NW ECM: RM File Info)
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
SAP_BASIS (Software Component) SAP Basis Component⤷
BC-SRV-RM (Application Component) SAP Records Management⤷
SRM_ECM_IMPL (Package) Records Management SPI (ECM) ImplementationMeta Relationship - Using
| # | Relationship type | Using | Short Description | Created on |
|---|---|---|---|---|
| 1 | Inheritance (c INHERITING FROM c_ref) | CL_SRM_ECM_NODE_INFO | NW ECM: RM Node Info Implementation | 20081127 |
| 2 | Interface implementation (CLASS c. INTERFACES i_ref) | IF_NWECM_BINARY | NW ECM: Byte Sequence | 20081127 |
| 3 | Interface implementation (CLASS c. INTERFACES i_ref) | IF_NWECM_CONTENT | NW ECM: File Content | 20081127 |
| 4 | Interface implementation (CLASS c. INTERFACES i_ref) | IF_NWECM_FILE_INFO | ECMI: Connector-Specific File Info | 20081127 |
Properties
| Class | CL_SRM_ECM_FILE_INFO | |
| Short Description | NW ECM: RM File Info | |
| Super Class | CL_SRM_ECM_NODE_INFO | NW ECM: RM Node Info Implementation |
| 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 | 20081127 | 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 | SRMCF |
Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
| 4 | SRMGS |
Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
| # | Interface | Abstract | Final | Description | Created on |
|---|---|---|---|---|---|
| 1 | IF_NWECM_BINARY | NW ECM: Byte Sequence | 20081127 | ||
| 2 | IF_NWECM_CONTENT | NW ECM: File Content | 20081127 | ||
| 3 | IF_NWECM_FILE_INFO | ECMI: Connector-Specific File Info | 20081127 |
Friends
Class CL_SRM_ECM_FILE_INFO has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | MO_STREAM |
Instance attribute | Public | Object reference (TYPE REF TO) | IF_NWECM_INPUT_STREAM | NW ECM: Streamed Binary Reader | 20081127 | ||
| 2 | MV_MIMETYPE |
Instance attribute | Private | Type reference (TYPE) | STRING | Mimetype | 20081127 | ||
| 3 | MV_SIZE |
Instance attribute | Private | Type reference (TYPE) | NWECM_LONG | Lenght of a file in bytes | 20081127 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | GET_BYTES_INTERNAL_REUSE |
Instance method | Public | Method | Get Document Content (method internal reuseable) | 20090427 |
| 2 | GET_COMPONENT_VALUES |
Instance method | Public | Method | Get Size and Type and Set it in Global Class Attributes | 20081127 |
| 3 | GET_CONTENT |
Instance method | Public | Method | Get Content of a file | 20081127 |
| 4 | GET_CONTENT_ATTRIBUTES |
Instance method | Public | Method | Get Mime Type and Size of Content | 20081127 |
| 5 | GET_DOC_ID |
Instance method | Public | Method | Get Document ID of DocumentObjectInstance | 20090427 |
| 6 | GET_FILE_OBJECT |
Instance method | Public | Method | Get File Object Reference (Here: Document Object) | 20081127 |
| 7 | GET_SESSION_INFO |
Instance method | Public | Method | Get Session Info | 20081127 |
| 8 | GET_STREAM |
Instance method | Public | Method | Get Mime Type and Size of Content | 20081127 |
| 9 | GET_TYPE_INTERNAL_REUSE |
Instance method | Public | Method | Get the MIME-TYPE of this file (method internal reuseable) | 20090429 |
| 10 | SET_HASH_VALUE |
Instance method | Public | Method | Set HASH Value for optimistic locking (comparision of attr.) | 20090427 |
| 11 | SET_SESSION_INFO |
Instance method | Public | Method | Set Session Info | 20081127 |
Events
Class CL_SRM_ECM_FILE_INFO has no event.
Types
Class CL_SRM_ECM_FILE_INFO has no local type.
Method Signatures
Method GET_BYTES_INTERNAL_REUSE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IV_AVOID_HASH_CALCULATION | Call by reference | Type reference (TYPE) | BOOLEAN | IF_SRM=>FALSE | If athwart call of private method, set = ABAP_TRUE | 20090427 | |
| 2 | Importing |
IV_USERNAME | Call by reference | Type reference (TYPE) | SYUNAME | SY-UNAME | User Name | 20090427 | |
| 3 |  Exporting |
OT_RETURN | Call by reference | Type reference (TYPE) | BAPIRET2_T | Return parameter table | 20090427 | ||
| 4 | Exporting |
OV_BYTES | Value transfer | Type reference (TYPE) | XSTRING | Content of file | 20090427 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_SRM_ECM_APPL_LOG |
20090427 |
Method GET_COMPONENT_VALUES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IO_SP_DOCUMENT | Call by reference | Object reference (TYPE REF TO) | IF_SRM_SP_DOCUMENT | Document backedn API | 20081127 | ||
| 2 | Importing |
IT_COMPONENT_TAB | Call by reference | Type reference (TYPE) | SRMGS_COMPONENTS | Component Table (size and type) | 20081127 | ||
| 3 | Exporting |
OT_RETURN | Call by reference | Type reference (TYPE) | BAPIRET2_T | Return parameter table | 20081127 | ||
| 4 | Exporting |
OV_MIMETYPE | Call by reference | Type reference (TYPE) | STRING | Mime type | 20081127 | ||
| 5 | Exporting |
OV_SIZE | Call by reference | Type reference (TYPE) | NWECM_LONG | Lenght of a file in bytes | 20081127 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRM_ECM_APPL_LOG |
Application Log of SRM ECM | 20081127 |
Method GET_CONTENT 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 | 20081127 | ||
| 2 |  Returning |
RO_CONTENT | Value transfer | Object reference (TYPE REF TO) | IF_NWECM_CONTENT | NW ECM: File Info Implementation | 20081127 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRM_ECM_APPL_LOG |
Application Log of SRM ECM | 20081127 |
Method GET_CONTENT_ATTRIBUTES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IO_SP_DOCUMENT | Call by reference | Object reference (TYPE REF TO) | IF_SRM_SP_DOCUMENT | Document backedn API | 20081127 | ||
| 2 | Exporting |
OT_RETURN | Call by reference | Type reference (TYPE) | BAPIRET2_T | Return parameter table | 20081127 | ||
| 3 | Exporting |
OV_MIMETYPE | Call by reference | Type reference (TYPE) | STRING | Mime type | 20081127 | ||
| 4 | Exporting |
OV_SIZE | Call by reference | Type reference (TYPE) | NWECM_LONG | Lenght of a file in bytes | 20081127 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRM_ECM_APPL_LOG |
NW ECM: Repository Exception | 20081127 |
Method GET_DOC_ID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IO_SRM_SP_DOCUMENT | Call by reference | Object reference (TYPE REF TO) | CL_SRM_SP_DOCUMENT | Represents SP Document Back End | 20090427 | ||
| 2 | Exporting |
OT_RETURN | Call by reference | Type reference (TYPE) | BAPIRET2_T | Return parameter table | 20090427 | ||
| 3 | Exporting |
OV_DOC_ID | Call by reference | Type reference (TYPE) | STRING | Return DOC-ID | 20090427 | ||
| 4 | Exporting |
OV_NODE_ID_TECH | Call by reference | Type reference (TYPE) | STRING | technical ID | 20090429 | ||
| 5 | Exporting |
OV_PATHNAME | Call by reference | Type reference (TYPE) | STRING | Pathname | 20090427 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRM_ECM_APPL_LOG |
Application Log of SRM ECM | 20090427 |
Method GET_FILE_OBJECT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
OR_SRM_SP_DOCUMENT | Value transfer | Object reference (TYPE REF TO) | IF_SRM_SP_DOCUMENT | Document backedn API | 20081127 | ||
| 2 | Exporting |
OT_RETURN | Call by reference | Type reference (TYPE) | BAPIRET2_T | Return parameter table | 20081127 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRM_ECM_APPL_LOG |
NW ECM Repository Exception | 20081127 |
Method GET_SESSION_INFO Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
OR_SESSION_INFO | Call by reference | Object reference (TYPE REF TO) | IF_NWECM_SESSION_INFO | NW ECM: Session Info for User and Workspace Identification | 20081127 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRM_ECM_APPL_LOG |
Application Log of SRM ECM | 20081127 |
Method GET_STREAM Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IO_SP_DOCUMENT | Call by reference | Object reference (TYPE REF TO) | IF_SRM_SP_DOCUMENT | Document backedn API | 20081127 | ||
| 2 | Exporting |
OT_RETURN | Call by reference | Type reference (TYPE) | BAPIRET2_T | Return parameter table | 20081127 | ||
| 3 | Exporting |
OV_XSTRING | Call by reference | Type reference (TYPE) | XSTRING | binary content of file | 20081127 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRM_ECM_APPL_LOG |
Document Client | 20081127 |
Method GET_TYPE_INTERNAL_REUSE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_ATHWART_CALL | Call by reference | Type reference (TYPE) | BOOLEAN | ABAP_FALSE | To be set on true, if no if_nwecm-method calls this method | 20090429 | |
| 2 | Exporting |
OT_RETURN | Call by reference | Type reference (TYPE) | BAPIRET2_T | Return parameter table | 20090429 | ||
| 3 | Exporting |
OV_DOC_ID | Call by reference | Type reference (TYPE) | STRING | further more information, here doc-id | 20090429 | ||
| 4 | Exporting |
OV_EXCEPTION_TYPE | Call by reference | Type reference (TYPE) | SEOSCONAME | Only needed by prime-method not for athwart call | 20090429 | ||
| 5 | Exporting |
OV_MIME_TYPE | Value transfer | Type reference (TYPE) | STRING | MimeType of file | 20090429 | ||
| 6 | Exporting |
OV_PATHNAME | Call by reference | Type reference (TYPE) | STRING | further more information, here path | 20090429 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRM_ECM_APPL_LOG |
Application Log of SRM ECM | 20090429 |
Method SET_HASH_VALUE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IO_SRM_SP_DOCUMENT | Call by reference | Object reference (TYPE REF TO) | CL_SRM_SP_DOCUMENT | Document Back-End API | 20090427 | ||
| 2 | Importing |
IV_DOC_ID_TECH | Call by reference | Type reference (TYPE) | STRING | DOC-ID with version and variant | 20090429 | ||
| 3 | Importing |
IV_PATHNAME | Call by reference | Type reference (TYPE) | STRING | Fully pathname | 20090427 | ||
| 4 | Importing |
IV_USERNAME | Call by reference | Type reference (TYPE) | SYUNAME | User Name | 20090427 | ||
| 5 | Exporting |
OT_RETURN | Call by reference | Type reference (TYPE) | BAPIRET2_T | Return parameter table | 20090427 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRM_ECM_APPL_LOG |
Application Log of SRM ECM | 20090427 |
Method SET_SESSION_INFO 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 | 20081127 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRM_ECM_APPL_LOG |
Application Log of SRM ECM | 20081127 |
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in | 720 |
