SAP ABAP Interface /IPRO/IF_DOCB_ATTRIBUTE (Attribute)
Hierarchy
☛
SAP_BS_FND (Software Component) SAP Business Suite Foundation
⤷
CA-GTF-DOB (Application Component) Document Builder
⤷
/IPRO/UI/INTERFACE/ (Package) BADI's, Interfaces
⤷
⤷
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface composition (i COMPRISING i_ref) | /IPRO/IF_DOCB_ELEMENT | Interface to document builder element | 20040121 |
| 2 | Interface composition (i COMPRISING i_ref) | /IPRO/IF_DOCB_SECTION | Interface to document sections | 20031204 |
| 3 | Interface composition (i COMPRISING i_ref) | /IPRO/IF_DOCB_VARIABLE | Interface to document builder variable | 20031126 |
| 4 | Interface implementation (CLASS c. INTERFACES i_ref) | /IPRO/CL_UI_ATTRIBUTE | An attribute for the UI layer | 20040210 |
Properties
| Interface | /IPRO/IF_DOCB_ATTRIBUTE | |
| Short Description | Attribute |
General Data
| Package | /IPRO/UI/INTERFACE/ | BADI's, Interfaces |
| Created | 20031106 | SAP |
| Last changed | 20110908 | SAP |
| Unicode checks active |
Forward declarations
Interface /IPRO/IF_DOCB_ATTRIBUTE has no forward declaration.
Interfaces
| # | Interface | Abstract | Final | Description | Created on |
|---|---|---|---|---|---|
| 1 | /IPRO/IF_MODEL | Document Builder Model Interface | 20031208 | ||
| 2 | /IPRO/IF_SUBJECT | Document Builder Subject Interface | 20040203 | ||
| 3 | /IPRO/IF_VISIBILITY | Visibility of an entity | 20040113 |
Friends
Interface /IPRO/IF_DOCB_ATTRIBUTE has no friend.
Attributes
Interface /IPRO/IF_DOCB_ATTRIBUTE has no attribute.
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Method | Add a node | 20031106 | |
| 2 | Instance method | Public | Method | Get an attribute value | 20031106 | |
| 3 | Instance method | Public | Method | Get attribute value by reference | 20031208 | |
| 4 | Instance method | Public | Method | Child nodes | 20031106 | |
| 5 | Instance method | Public | Method | Get document | 20040129 | |
| 6 | Instance method | Public | Method | Label | 20031106 | |
| 7 | Instance method | Public | Method | Name of the attribute | 20031106 | |
| 8 | Instance method | Public | Method | Parent node | 20031106 | |
| 9 | Instance method | Public | Method | Subnodes as a path | 20031106 | |
| 10 | Instance method | Public | Method | Type | 20031106 | |
| 11 | Instance method | Public | Method | Lookup | 20031106 | |
| 12 | Instance method | Public | Method | Remove a node | 20031106 | |
| 13 | Instance method | Public | Method | Replaces the elements position or add it | 20090520 | |
| 14 | Instance method | Public | Method | Set the attribute value | 20031106 | |
| 15 | Instance method | Public | Method | Set parent node | 20031120 |
Events
Interface /IPRO/IF_DOCB_ATTRIBUTE has no event.
Types
Interface /IPRO/IF_DOCB_ATTRIBUTE has no local type.
Method Signatures
Method ADD Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IO_ATTRIBUTE | Call by reference | Object reference (TYPE REF TO) | /IPRO/IF_DOCB_ATTRIBUTE | Attribute | 20031106 | |||
| 2 | IV_INSERT_AFTER_ELEMENT | Call by reference | Type reference (TYPE) | XFELD | Should the element be added after the marked one | 20080801 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Duplicate child node | 20031125 | ||
| 2 | Object does not support the request | 20031125 |
Method GET Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | E_DATA | Call by reference | Type reference (TYPE) | ANY | 20031106 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Object does not support the request | 20031125 | ||
| 2 | The type of a paremeter does not fit | 20031125 |
Method GET_BY_REF Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | PRR_REFERENCE | Value transfer | Object reference (TYPE REF TO) | DATA | Attribute value | 20031208 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Object does not support the request | 20031208 |
Method GET_CHILDREN Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IT_CHILDREN | Value transfer | Type reference (TYPE) | /IPRO/TT_ATTRIBUTES | Import children to collect all children | 20041001 | |||
| 2 | IV_COLLECT | Call by reference | Type reference (TYPE) | SEU_BOOL | true to collect all children | 20041001 | |||
| 3 | IV_DEEP | Call by reference | Type reference (TYPE) | SEU_BOOL | boolean variable (X=true, space=false) | 20040503 | |||
| 4 | IV_LEAVES_ONLY | Call by reference | Type reference (TYPE) | SEU_BOOL | boolean variable (X=true, space=false) | 20031106 | |||
| 5 | IV_NODES_ONLY | Call by reference | Type reference (TYPE) | SEU_BOOL | boolean variable (X=true, space=false) | 20031106 | |||
| 6 | RT_CHILDREN | Value transfer | Type reference (TYPE) | /IPRO/TT_ATTRIBUTES | Attributes | 20031106 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Parameter error | 20031125 |
Method GET_DOCUMENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RO_DOCUMENT | Value transfer | Object reference (TYPE REF TO) | /IPRO/IF_DOCUMENT | Document Builder Document | 20040129 |
Method GET_DOCUMENT on Interface /IPRO/IF_DOCB_ATTRIBUTE has no exception.
Method GET_LABEL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_LABEL | Value transfer | Type reference (TYPE) | STRING | 20031106 |
Method GET_LABEL on Interface /IPRO/IF_DOCB_ATTRIBUTE has no exception.
Method GET_NAME Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_NAME | Value transfer | Type reference (TYPE) | STRING | 20031106 |
Method GET_NAME on Interface /IPRO/IF_DOCB_ATTRIBUTE has no exception.
Method GET_PARENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RO_ATTRIBUTE | Value transfer | Object reference (TYPE REF TO) | /IPRO/IF_DOCB_ATTRIBUTE | Attribute | 20031106 |
Method GET_PARENT on Interface /IPRO/IF_DOCB_ATTRIBUTE has no exception.
Method GET_PATH Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RT_PATH | Value transfer | Type reference (TYPE) | /IPRO/TT_PATH | Path | 20031106 |
Method GET_PATH on Interface /IPRO/IF_DOCB_ATTRIBUTE has no exception.
Method GET_TYPE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RS_TYPE | Value transfer | Type reference (TYPE) | /IPRO/S_VAR_TYPE | Runtime Type Identification | 20031124 |
Method GET_TYPE on Interface /IPRO/IF_DOCB_ATTRIBUTE has no exception.
Method LOOKUP Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_NAME | Call by reference | Type reference (TYPE) | STRING | 20031106 | ||||
| 2 | RO_ATTRIBUTE | Value transfer | Object reference (TYPE REF TO) | /IPRO/IF_DOCB_ATTRIBUTE | Attribute | 20031106 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Specified child node not found | 20031125 |
Method REMOVE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IO_ATTRIBUTE | Call by reference | Object reference (TYPE REF TO) | /IPRO/IF_DOCB_ATTRIBUTE | Attribute | 20031106 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Object does not support the request | 20031125 | ||
| 2 | Specified child node not found | 20031125 |
Method REPLACE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IO_ATTRIBUTE | Call by reference | Object reference (TYPE REF TO) | /IPRO/IF_DOCB_ATTRIBUTE | Attribute | 20090520 | |||
| 2 | PIV_INSERT_BELOW | Call by reference | Type reference (TYPE) | XFELD | Checkbox | 20090916 |
Method REPLACE on Interface /IPRO/IF_DOCB_ATTRIBUTE has no exception.
Method SET Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_DATA | Call by reference | Type reference (TYPE) | ANY | 20031106 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Object does not support the request | 20031125 | ||
| 2 | Base class for attribute exceptions | 20031125 |
Method SET_PARENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IO_PARENT | Call by reference | Object reference (TYPE REF TO) | /IPRO/IF_DOCB_ATTRIBUTE | Attribute | 20031120 |
Method SET_PARENT on Interface /IPRO/IF_DOCB_ATTRIBUTE has no exception.
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in | 10A |