SAP ABAP Class /IPRO/IF_DOCB_FACTORY (Document Builder Factory)
Meta Relationship - Using
| # | Relationship type | Using | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface composition (i COMPRISING i_ref) | /IPRO/IF_SUBJECT | Document Builder Subject Interface | 20040609 |
Properties
| Class | /IPRO/IF_DOCB_FACTORY | |
| Short Description | Document Builder Factory | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | ||
| Created | 20031111 | SAP |
| Last change | 20110908 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
Class /IPRO/IF_DOCB_FACTORY has no forward declaration.
Interfaces
Class /IPRO/IF_DOCB_FACTORY has no interface implemented.
Friends
Class /IPRO/IF_DOCB_FACTORY has no friend class.
Attributes
Class /IPRO/IF_DOCB_FACTORY has no attribute.
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | BUILD_FROM |
Instance method | Public | Method | Create a Document Builder document from existing document | 20040723 |
| 2 | BUILD_FROM2 |
Instance method | Public | Method | Create a Document Builder document from existing document | 20051024 |
| 3 | COMMIT |
Instance method | Public | Method | Commit | 20040416 |
| 4 | CREATE |
Instance method | Public | Method | Create a Document Builder document | 20031111 |
| 5 | CREATE_TEMPLATE |
Instance method | Public | Method | Create a Document Builder template | 20040518 |
| 6 | CREATE_USER_TEMPLATE |
Instance method | Public | Method | Create a Document Builder user template | 20040518 |
| 7 | GET_LATEST_RELEASED_VERSION |
Instance method | Public | Method | Returns a reference of the latest released version | 20070725 |
| 8 | GET_QUERY_METHOD |
Instance method | Public | Method | Query method | 20040202 |
| 9 | IS_RELEVANT_FOR_UPDATE |
Instance method | Public | Method | At least one subobject needs to be updated | 20040609 |
| 10 | LOOKUP |
Instance method | Public | Method | Factory lookup for document | 20040416 |
| 11 | LOOKUP_MANY |
Instance method | Public | Method | Factory lookup for documents | 20040416 |
| 12 | LOOKUP_MANY_TMPL |
Instance method | Public | Method | Factory lookup for templates | 20040518 |
| 13 | LOOKUP_MANY_USRTMPL |
Instance method | Public | Method | Factory lookup for user templates | 20040518 |
| 14 | LOOKUP_TEMPLATE |
Instance method | Public | Method | Factory lookup for template | 20040518 |
| 15 | LOOKUP_USER_TEMPLATE |
Instance method | Public | Method | Factory lookup for user template | 20040518 |
| 16 | OPEN |
Instance method | Public | Method | Open an existing Document Builder document | 20031111 |
| 17 | OPEN_TEMPLATE |
Instance method | Public | Method | Open an existing Document Builder template | 20040518 |
| 18 | OPEN_USER_TEMPLATE |
Instance method | Public | Method | Open an existing Document Builder user template | 20040518 |
Events
Class /IPRO/IF_DOCB_FACTORY has no event.
Types
Class /IPRO/IF_DOCB_FACTORY has no local type.
Method Signatures
Method BUILD_FROM Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
PIO_SRC_DOCUMENT | Call by reference | Object reference (TYPE REF TO) | /IPRO/IF_DOCUMENT | Document Builder Document Interface | 20080813 | ||
| 2 | Importing |
PIV_COMPARE_ONLY | Call by reference | Type reference (TYPE) | XFELD | Document is only used for Update Report | 20080812 | ||
| 3 | Importing |
PIV_SRC_DOCUMENT | Call by reference | Type reference (TYPE) | GUID | SRC Globally Unique Identifier | 20040723 | ||
| 4 | Importing |
PIV_SRC_DOCUMENT_ID | Call by reference | Type reference (TYPE) | /IPRO/DOCMNT_ID | SRC document number | 20040723 | ||
| 5 | Importing |
PIV_TGT_DOCDATE | Call by reference | Type reference (TYPE) | /IPRO/DOCDATE | Target document date | 20040723 | ||
| 6 | Importing |
PIV_TGT_DOCSL | Call by reference | Type reference (TYPE) | /IPRO/DOCSL | Target document selection | 20040723 | ||
| 7 |  Returning |
PRO_DOCUMENT | Value transfer | Object reference (TYPE REF TO) | /IPRO/IF_DOCUMENT | Document builder object | 20040723 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  /IPRO/CX_ACTION_ILLEGAL |
Illegal Document Builder Action | 20040723 | |
| 2 | /IPRO/CX_ACTION_NOAUTH |
No Authorization for Action | 20040723 |
Method BUILD_FROM2 Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
PIS_HEADER | Call by reference | Type reference (TYPE) | /IPRO/TDOCMNT | Document table | 20051024 | ||
| 2 | Returning |
PRO_DOCUMENT | Value transfer | Object reference (TYPE REF TO) | /IPRO/IF_DOCUMENT | Document builder object | 20051024 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | /IPRO/CX_ACTION_ILLEGAL |
Illegal Document Builder Action | 20051024 | |
| 2 | /IPRO/CX_ACTION_NOAUTH |
No Authorization for Action | 20051024 | |
| 3 | /IPRO/CX_ATTRIBUTE |
Base class for attribute exceptions | 20051024 | |
| 4 | /IPRO/CX_SERIALIZER_FAILED_AT |
Serialization/Deserialization failed at element | 20051024 |
Method COMMIT Signature
Method COMMIT on class /IPRO/IF_DOCB_FACTORY has no parameter.
Method COMMIT on class /IPRO/IF_DOCB_FACTORY has no exception.
Method CREATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
PIO_REFERENCE | Call by reference | Object reference (TYPE REF TO) | /IPRO/IF_DOCUMENT | Reference document | 20040628 | ||
| 2 | Importing |
PIV_COMPARE_ONLY | Call by reference | Type reference (TYPE) | XFELD | Document is used only to compare in Update Report | 20080812 | ||
| 3 | Importing |
PIV_NEW_VERSION | Call by reference | Type reference (TYPE) | CHAR1 | Single-Character Flag | 20070529 | ||
| 4 | Returning |
PRO_DOCUMENT | Value transfer | Object reference (TYPE REF TO) | /IPRO/IF_DOCUMENT | Document Builder Document Interface | 20040420 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | /IPRO/CX_ACTION_ILLEGAL |
Illegal Document Builder Action | 20040416 | |
| 2 | /IPRO/CX_ACTION_NOAUTH |
No Authorization for Action | 20040416 |
Method CREATE_TEMPLATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
PIO_REFERENCE | Call by reference | Object reference (TYPE REF TO) | /IPRO/IF_DOCUMENT | Reference document | 20040628 | ||
| 2 | Importing |
PIV_NEW_VERSION | Call by reference | Type reference (TYPE) | CHAR1 | Flag to indicate if this should be a new version of the ref | 20070517 | ||
| 3 | Returning |
PRO_TEMPLATE | Value transfer | Object reference (TYPE REF TO) | /IPRO/IF_DOCUMENT | Document Builder Document Interface | 20040518 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | /IPRO/CX_ACTION_ILLEGAL |
Illegal Document Builder Action | 20040518 | |
| 2 | /IPRO/CX_ACTION_NOAUTH |
No Authorization for Action | 20040518 |
Method CREATE_USER_TEMPLATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
PIO_REFERENCE | Call by reference | Object reference (TYPE REF TO) | /IPRO/IF_DOCUMENT | Reference document | 20040628 | ||
| 2 | Returning |
PRO_USER_TEMPLATE | Value transfer | Object reference (TYPE REF TO) | /IPRO/IF_DOCUMENT | Document Builder Document Interface | 20040518 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | /IPRO/CX_ACTION_ILLEGAL |
Illegal Document Builder Action | 20040518 | |
| 2 | /IPRO/CX_ACTION_NOAUTH |
No Authorization for Action | 20040518 |
Method GET_LATEST_RELEASED_VERSION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
PIO_DOCUMENT | Call by reference | Object reference (TYPE REF TO) | /IPRO/IF_DOCUMENT | Document Builder Document Interface | 20070725 | ||
| 2 | Returning |
PRO_RELEASED_DOCUMENT | Value transfer | Object reference (TYPE REF TO) | /IPRO/IF_DOCUMENT | Document Builder Document Interface | 20070725 |
Method GET_LATEST_RELEASED_VERSION on class /IPRO/IF_DOCB_FACTORY has no exception.
Method GET_QUERY_METHOD Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
PIV_TEMPLATE_MODE | Call by reference | Type reference (TYPE) | SEU_BOOL | Template mode | 20040606 | ||
| 2 | Returning |
PRO_DBL_MODEL | Value transfer | Object reference (TYPE REF TO) | /IPRO/IF_DATABLADE_MODEL | Datablade model interface | 20040202 |
Method GET_QUERY_METHOD on class /IPRO/IF_DOCB_FACTORY has no exception.
Method IS_RELEVANT_FOR_UPDATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
PRV_RELEVANT | Value transfer | Type reference (TYPE) | SEU_BOOL | relevant | 20040609 |
Method IS_RELEVANT_FOR_UPDATE on class /IPRO/IF_DOCB_FACTORY has no exception.
Method LOOKUP Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
PIV_DOCMNT | Call by reference | Type reference (TYPE) | /IPRO/TDOCMNT-DOCMNT | Globally Unique Identifier | 20040416 | ||
| 2 | Importing |
PIV_DOCMNT_ID | Call by reference | Type reference (TYPE) | /IPRO/TDOCMNT-DOCMNT_ID | Document Number | 20040613 | ||
| 3 | Importing |
PIV_VERSION | Call by reference | Type reference (TYPE) | /IPRO/TDOCMNT-VERSION | Version Number | 20070727 | ||
| 4 | Returning |
PRO_DOCUMENT | Value transfer | Object reference (TYPE REF TO) | /IPRO/IF_DOCUMENT | Document Builder Document Interface | 20040416 |
Method LOOKUP on class /IPRO/IF_DOCB_FACTORY has no exception.
Method LOOKUP_MANY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
PIV_MODE | Call by reference | Type reference (TYPE) | CHAR1 | Mode | 20040416 | ||
| 2 | Returning |
PRT_DOCUMENTS | Value transfer | Type reference (TYPE) | /IPRO/TT_DOCUMENTS | Table of Document Builder documents | 20040416 |
Method LOOKUP_MANY on class /IPRO/IF_DOCB_FACTORY has no exception.
Method LOOKUP_MANY_TMPL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
PIV_MODE | Call by reference | Type reference (TYPE) | CHAR1 | Mode | 20040518 | ||
| 2 | Returning |
PRT_TEMPLATES | Value transfer | Type reference (TYPE) | /IPRO/TT_DOCUMENTS | Table of Document Builder documents | 20040518 |
Method LOOKUP_MANY_TMPL on class /IPRO/IF_DOCB_FACTORY has no exception.
Method LOOKUP_MANY_USRTMPL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
PIV_MODE | Call by reference | Type reference (TYPE) | CHAR1 | Mode | 20040518 | ||
| 2 | Returning |
PRT_USER_TEMPLATES | Value transfer | Type reference (TYPE) | /IPRO/TT_DOCUMENTS | Table of Document Builder documents | 20040518 |
Method LOOKUP_MANY_USRTMPL on class /IPRO/IF_DOCB_FACTORY has no exception.
Method LOOKUP_TEMPLATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
PIV_TMPL | Call by reference | Type reference (TYPE) | /IPRO/TMPL | Template | 20040518 | ||
| 2 | Importing |
PIV_VERSION | Call by reference | Type reference (TYPE) | /IPRO/TDOCMNT-VERSION | Version Number | 20070516 | ||
| 3 | Returning |
PRO_TEMPLATE | Value transfer | Object reference (TYPE REF TO) | /IPRO/IF_DOCUMENT | Document Builder Document Interface | 20040518 |
Method LOOKUP_TEMPLATE on class /IPRO/IF_DOCB_FACTORY has no exception.
Method LOOKUP_USER_TEMPLATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
PIV_USRTMPL | Call by reference | Type reference (TYPE) | GUID | User template | 20040518 | ||
| 2 | Returning |
PRO_USER_TEMPLATE | Value transfer | Object reference (TYPE REF TO) | /IPRO/IF_DOCUMENT | Document Builder Document Interface | 20040518 |
Method LOOKUP_USER_TEMPLATE on class /IPRO/IF_DOCB_FACTORY has no exception.
Method OPEN Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
PIV_DOCMNT | Call by reference | Type reference (TYPE) | /IPRO/TDOCMNT-DOCMNT | Globally Unique Identifier | 20040420 | ||
| 2 | Importing |
PIV_DOCMNT_ID | Call by reference | Type reference (TYPE) | /IPRO/TDOCMNT-DOCMNT_ID | Document Number | 20040503 | ||
| 3 | Importing |
PIV_DOCMNT_VERSION | Call by reference | Type reference (TYPE) | /IPRO/TDOCMNT-VERSION | Version Number | 20070727 | ||
| 4 | Returning |
PRO_DOCUMENT | Value transfer | Object reference (TYPE REF TO) | /IPRO/IF_DOCUMENT | Document Builder Document Interface | 20040420 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | /IPRO/CX_ACTION_ILLEGAL |
Illegal Document Builder Action | 20040416 | |
| 2 | /IPRO/CX_ACTION_NOAUTH |
No Authorization for Action | 20040416 | |
| 3 | /IPRO/CX_SERIALIZER_FAILED_AT |
Serialization/Deserialization failed at element | 20050916 |
Method OPEN_TEMPLATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
PIV_TMPL | Call by reference | Type reference (TYPE) | /IPRO/TMPL | Template | 20040518 | ||
| 2 | Importing |
PIV_VERSION | Call by reference | Type reference (TYPE) | /IPRO/TDOCMNT-VERSION | Version Number | 20070516 | ||
| 3 | Returning |
PRO_TEMPLATE | Value transfer | Object reference (TYPE REF TO) | /IPRO/IF_DOCUMENT | Document Builder Document Interface | 20040518 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | /IPRO/CX_ACTION_ILLEGAL |
Illegal Document Builder Action | 20040518 | |
| 2 | /IPRO/CX_ACTION_NOAUTH |
No Authorization for Action | 20040518 | |
| 3 | /IPRO/CX_SERIALIZER_FAILED_AT |
Serialization/Deserialization failed at element | 20050916 |
Method OPEN_USER_TEMPLATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
PIV_USRTMPL | Call by reference | Type reference (TYPE) | GUID | User Template | 20040518 | ||
| 2 | Returning |
PRO_USER_TEMPLATE | Value transfer | Object reference (TYPE REF TO) | /IPRO/IF_DOCUMENT | Document Builder Document Interface | 20040518 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | /IPRO/CX_ACTION_ILLEGAL |
Illegal Document Builder Action | 20040518 | |
| 2 | /IPRO/CX_ACTION_NOAUTH |
No Authorization for Action | 20040518 | |
| 3 | /IPRO/CX_SERIALIZER_FAILED_AT |
Serialization/Deserialization failed at element | 20050916 |
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in |
