SAP ABAP Interface /IPRO/IF_DOCB_USER_RESOURCE (User resource interface)
Hierarchy
☛
SAP_BS_FND (Software Component) SAP Business Suite Foundation
⤷
CA-GTF-DOB (Application Component) Document Builder
⤷
/IPRO/INTERFACE (Package) BADI's, Interfaces
⤷
⤷
Properties
| Interface | /IPRO/IF_DOCB_USER_RESOURCE | |
| Short Description | User resource interface |
General Data
| Package | /IPRO/INTERFACE | BADI's, Interfaces |
| Created | 20031106 | SAP |
| Last changed | 20110908 | SAP |
| Unicode checks active |
Forward declarations
Interface /IPRO/IF_DOCB_USER_RESOURCE has no forward declaration.
Interfaces
| # | Interface | Abstract | Final | Description | Created on |
|---|---|---|---|---|---|
| 1 | /IPRO/IF_MODEL | Document Builder Model Interface | 20031215 |
Friends
Interface /IPRO/IF_DOCB_USER_RESOURCE has no friend.
Attributes
Interface /IPRO/IF_DOCB_USER_RESOURCE has no attribute.
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Method | Add a new user clause | 20031204 | |
| 2 | Instance method | Public | Method | Add a new user/office template | 20031204 | |
| 3 | Instance method | Public | Method | Delete an existing user clause | 20031204 | |
| 4 | Instance method | Public | Method | Delete an existing user/office template | 20031204 | |
| 5 | Instance method | Public | Method | Filter templates based on criterias | 20040115 | |
| 6 | Instance method | Public | Method | Return a list of office template for the specific office | 20031204 | |
| 7 | Instance method | Public | Method | Return a list of system templates | 20040113 | |
| 8 | Instance method | Public | Method | Return a list of user clauses for the specific user | 20031204 | |
| 9 | Instance method | Public | Method | Return a list of user template for the specific user | 20031204 | |
| 10 | Instance method | Public | Method | Persist all user resources back to database | 20031204 |
Events
Interface /IPRO/IF_DOCB_USER_RESOURCE has no event.
Types
Interface /IPRO/IF_DOCB_USER_RESOURCE has no local type.
Method Signatures
Method ADD_CLAUSE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | PIR_CLAUSE | Call by reference | Object reference (TYPE REF TO) | /IPRO/IF_DOCB_ELEMENT | Interface to document builder element | 20031204 |
Method ADD_CLAUSE on Interface /IPRO/IF_DOCB_USER_RESOURCE has no exception.
Method ADD_TEMPLATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | PIR_TMPL | Call by reference | Object reference (TYPE REF TO) | /IPRO/IF_DOCB_TEMPLATE | Template interface | 20031204 |
Method ADD_TEMPLATE on Interface /IPRO/IF_DOCB_USER_RESOURCE has no exception.
Method DEL_CLAUSE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | PIR_CLAUSE | Call by reference | Object reference (TYPE REF TO) | /IPRO/IF_DOCB_ELEMENT | Interface to document builder element | 20031204 |
Method DEL_CLAUSE on Interface /IPRO/IF_DOCB_USER_RESOURCE has no exception.
Method DEL_TEMPLATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | PIR_TMPL | Call by reference | Object reference (TYPE REF TO) | /IPRO/IF_DOCB_TEMPLATE | Template interface | 20031204 |
Method DEL_TEMPLATE on Interface /IPRO/IF_DOCB_USER_RESOURCE has no exception.
Method FILTER_TEMPLATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | PCT_LIST | Call by reference | Type reference (TYPE) | /IPRO/TT_OBJECT_LIST | List of object | 20040115 | |||
| 2 | PIT_COND | Call by reference | Type reference (TYPE) | /IPRO/TT_CONDITION | Table type of search condition | 20040115 |
Method FILTER_TEMPLATE on Interface /IPRO/IF_DOCB_USER_RESOURCE has no exception.
Method GET_OFFICE_TEMPLATES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | PCT_LIST | Call by reference | Type reference (TYPE) | /IPRO/TT_OBJECT_LIST | List of templates | 20031204 | |||
| 2 | PIV_OFFICE | Call by reference | Type reference (TYPE) | /IPRO/OFFICE | This data element defines an office | 20031204 |
Method GET_OFFICE_TEMPLATES on Interface /IPRO/IF_DOCB_USER_RESOURCE has no exception.
Method GET_SYSTEM_TEMPLATES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | PCT_LIST | Call by reference | Type reference (TYPE) | /IPRO/TT_OBJECT_LIST | List of object | 20040113 |
Method GET_SYSTEM_TEMPLATES on Interface /IPRO/IF_DOCB_USER_RESOURCE has no exception.
Method GET_USER_CLAUSES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | PCT_CLAUSES | Call by reference | Type reference (TYPE) | /IPRO/TT_OBJECT_LIST | List of object | 20031204 | |||
| 2 | PIV_USER | Call by reference | Type reference (TYPE) | USRCHAR20 | User field with 20 characters | 20031204 |
Method GET_USER_CLAUSES on Interface /IPRO/IF_DOCB_USER_RESOURCE has no exception.
Method GET_USER_TEMPLATES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | PCT_LIST | Call by reference | Type reference (TYPE) | /IPRO/TT_OBJECT_LIST | The list of templates | 20031204 | |||
| 2 | PIV_USER | Call by reference | Type reference (TYPE) | USRCHAR20 | User ID | 20031204 |
Method GET_USER_TEMPLATES on Interface /IPRO/IF_DOCB_USER_RESOURCE has no exception.
Method WRITE_TO_DB Signature
Method WRITE_TO_DB on Interface /IPRO/IF_DOCB_USER_RESOURCE has no parameter.
Method WRITE_TO_DB on Interface /IPRO/IF_DOCB_USER_RESOURCE has no exception.
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in | 10A |