SAP ABAP Class CL_OPENXML_PARTCONTAINER (OpenXML Part Container)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-I18 (Application Component) Internationalization (I18N)
⤷
S_OOXML_OPC (Package) OpenXML Packaging
⤷
⤷
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Inheritance (c INHERITING FROM c_ref) | CL_OPENXML_PACKAGE | OpenXML Package | 20071119 |
| 2 | Inheritance (c INHERITING FROM c_ref) | CL_OPENXML_PART | OpenXML Part | 20071119 |
Properties
| Class | CL_OPENXML_PARTCONTAINER | |
| Short Description | OpenXML Part Container | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | S_OOXML_OPC | OpenXML Packaging |
| Created | 20071119 | SAP |
| Last change | 20090618 | SAP |
| 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) |
Interfaces
Class CL_OPENXML_PARTCONTAINER has no interface implemented.
Friends
Class CL_OPENXML_PARTCONTAINER has no friend class.
Attributes
Class CL_OPENXML_PARTCONTAINER has no attribute.
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Method | Add a new part with spec. content and relationship type | 20071121 | |
| 2 | Instance method | Public | Method | Add an external relationship to this container | 20071120 | |
| 3 | Instance method | Public | Method | Add an existing part by relating it to this container | 20071119 | |
| 4 | Instance method | Public | Method | Get content type | 20071122 | |
| 5 | Instance method | Public | Method | Get all external relationships | 20071120 | |
| 6 | Instance method | Public | Method | Get relationship id for specified part | 20071119 | |
| 7 | Instance method | Public | Method | Get all contained parts (related parts) | 20071120 | |
| 8 | Instance method | Public | Method | Get number of parts with given relationship type | 20071119 | |
| 9 | Instance method | Public | Method | Get parts of specified relationship type | 20071119 | |
| 10 | Instance method | Public | Method | Get child part by relationship id | 20071119 | |
| 11 | Instance method | Public | Method | Get part by URI | 20071119 | |
| 12 | Instance method | Public | Method | Return true if this has the given content type | 20071130 |
Events
Class CL_OPENXML_PARTCONTAINER has no event.
Types
Class CL_OPENXML_PARTCONTAINER has no local type.
Method Signatures
Method ADD_EXTENDED_PART Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_CONTENT_TYPE | Call by reference | Type reference (TYPE) | OXA_OPC_CONTENT_TYPE | Content Type | 20071121 | |||
| 2 | IV_EXT | Call by reference | Type reference (TYPE) | STRING | File Extension | 20071121 | |||
| 3 | IV_RELATION_TYPE | Call by reference | Type reference (TYPE) | OXA_OPC_RELATION_TYPE | Relationship Type | 20071121 | |||
| 4 | RR_PART | Value transfer | Object reference (TYPE REF TO) | CL_OPENXML_PART | OpenXML Part | 20071121 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Action is not allowed | 20071121 |
Method ADD_EXTERNAL_RELATIONSHIP Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_TARGETURI | Call by reference | Type reference (TYPE) | STRING | Relationship Target | 20071120 | |||
| 2 | IV_TYPE | Call by reference | Type reference (TYPE) | OXA_OPC_RELATION_TYPE | Relationship Type | 20071120 | |||
| 3 | RV_ID | Value transfer | Type reference (TYPE) | STRING | Relationship Id | 20071123 |
Method ADD_EXTERNAL_RELATIONSHIP on class CL_OPENXML_PARTCONTAINER has no exception.
Method ADD_PART Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IR_PART | Call by reference | Object reference (TYPE REF TO) | CL_OPENXML_PART | OpenXML Part | 20071119 | |||
| 2 | RR_PART | Value transfer | Object reference (TYPE REF TO) | CL_OPENXML_PART | OpenXML Part | 20071120 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Action is not allowed | 20071127 |
Method GET_CONTENT_TYPE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_TYPE | Value transfer | Type reference (TYPE) | OXA_OPC_CONTENT_TYPE | 20071122 |
Method GET_CONTENT_TYPE on class CL_OPENXML_PARTCONTAINER has no exception.
Method GET_EXTERNAL_RELATIONSHIPS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RT_RELATIONSHIPS | Value transfer | Type reference (TYPE) | OXT_OPC_RELATIONSHIPS | Open Packaging Conventions - Relationships | 20071120 |
Method GET_EXTERNAL_RELATIONSHIPS on class CL_OPENXML_PARTCONTAINER has no exception.
Method GET_ID_FOR_PART Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IR_PART | Call by reference | Object reference (TYPE REF TO) | CL_OPENXML_PART | OpenXML Part | 20071119 | |||
| 2 | RV_ID | Value transfer | Type reference (TYPE) | STRING | 20071119 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Part not found | 20071119 |
Method GET_PARTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RR_PARTS | Value transfer | Object reference (TYPE REF TO) | CL_OPENXML_PARTCOLLECTION | OpenXML Part Collection | 20071120 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Not a valid OpenXML/OPC Package | 20071120 |
Method GET_PARTS_COUNT_OF_TYPE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_TYPE | Call by reference | Type reference (TYPE) | OXA_OPC_RELATION_TYPE | Open Packaging Conventions - Relationship Type | 20071119 | |||
| 2 | RV_COUNT | Value transfer | Type reference (TYPE) | INT4 | Natural number | 20071119 |
Method GET_PARTS_COUNT_OF_TYPE on class CL_OPENXML_PARTCONTAINER has no exception.
Method GET_PARTS_OF_TYPE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_TYPE | Call by reference | Type reference (TYPE) | OXA_OPC_RELATION_TYPE | Open Packaging Conventions - Relationship Type | 20071119 | |||
| 2 | RR_PARTS | Value transfer | Object reference (TYPE REF TO) | CL_OPENXML_PARTCOLLECTION | OpenXML Part Collection | 20071119 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Not a valid OpenXML/OPC Package | 20071120 |
Method GET_PART_BY_ID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_ID | Call by reference | Type reference (TYPE) | STRING | 20071119 | ||||
| 2 | RR_PART | Value transfer | Object reference (TYPE REF TO) | CL_OPENXML_PART | OpenXML Part | 20071119 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Not a valid OpenXML/OPC Package | 20071119 | ||
| 2 | Part not found | 20071119 |
Method GET_PART_BY_URI Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IR_PARTURI | Call by reference | Object reference (TYPE REF TO) | CL_OPENXML_PARTURI | OpenXML Part URI | 20071119 | |||
| 2 | RR_PART | Value transfer | Object reference (TYPE REF TO) | CL_OPENXML_PART | OpenXML Part | 20071119 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Packaging Error - Invalid Content | 20071126 | ||
| 2 | Part not found | 20071119 |
Method HAS_CONTENT_TYPE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_TYPE | Call by reference | Type reference (TYPE) | OXA_OPC_CONTENT_TYPE | Content Type of a Part (e.g application/xml) | 20071130 | |||
| 2 | RV_BOOL | Value transfer | Type reference (TYPE) | ABAP_BOOL | 20071130 |
Method HAS_CONTENT_TYPE on class CL_OPENXML_PARTCONTAINER has no exception.
History
| Last changed by/on | SAP | 20090618 |
| SAP Release Created in | 711 |