SAP ABAP Interface IF_GRFN_API_SURVEY (Survey Template API interface)
Hierarchy
☛
GRCFND_A (Software Component) GRC Foundation ABAP
⤷
GRC-SPC (Application Component) Process Controls
⤷
GRPC_ENTITY_API (Package) GRC Process controls API
GRCFND_A (Software Component) GRC Foundation ABAP⤷
GRC-SPC (Application Component) Process Controls⤷
GRPC_ENTITY_API (Package) GRC Process controls API
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_GRFN_API_SURVEY | Survey Template API | 20091022 |
Properties
| Interface | IF_GRFN_API_SURVEY | |
| Short Description | Survey Template API interface |
General Data
| Package | GRPC_ENTITY_API | GRC Process controls API |
| Created | 20091022 | SAP |
| Last changed | 20141106 | |
| 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) |
Interfaces
| # | Interface | Abstract | Final | Description | Created on |
|---|---|---|---|---|---|
| 1 | IF_GRFN_API_BASIS | Basis interface for the GRC API | 20091022 |
Friends
Interface IF_GRFN_API_SURVEY has no friend.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | MV_OBJECT | Instance attribute | Public | Attribute reference (LIKE) | 20100406 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CREATE |
Static method | Public | Method | 20091022 | |
| 2 | DELETE |
Instance method | Public | Method | 20091022 | |
| 3 | QUERY |
Static method | Public | Method | 20091022 | |
| 4 | RETRIEVE |
Instance method | Public | Method | 20091022 | |
| 5 | SURVEY_VALUATIONS |
Static method | Public | Method | 20100407 | |
| 6 | UPDATE |
Instance method | Public | Method | 20091022 |
Events
Interface IF_GRFN_API_SURVEY has no event.
Types
Interface IF_GRFN_API_SURVEY has no local type.
Method Signatures
Method CREATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IO_SESSION | Value transfer | Object reference (TYPE REF TO) | CL_GRFN_API_SESSION | Session Management for GRC APIs | 20091022 | ||
| 2 | Importing |
IV_REGULATION_ID | Value transfer | Type reference (TYPE) | GRFN_API_OBJECT_ID | Object ID | 20091022 | ||
| 3 |  Returning |
RV_SURVEY_ID | Value transfer | Type reference (TYPE) | GRFN_API_OBJECT_ID | Object ID | 20091022 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_GRFN_EXCEPTION |
Generic GRC API exception | 20091022 |
Method DELETE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_REGULATION_ID | Value transfer | Type reference (TYPE) | GRFN_API_OBJECT_ID | Object ID | 20091022 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_GRFN_EXCEPTION |
Generic GRC API exception | 20091022 |
Method QUERY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
ET_SURVEY | Call by reference | Type reference (TYPE) | GRPC_T_API_SURVEY_DATA | Survey Template | 20100602 | ||
| 2 | Importing |
IO_SESSION | Value transfer | Object reference (TYPE REF TO) | CL_GRFN_API_SESSION | Session Management for GRC APIs | 20091022 | ||
| 3 | Importing |
IT_QCATEGORY_FILTER | Call by reference | Type reference (TYPE) | GRPC_T_API_QCATEGORY | Question category | 20091022 | ||
| 4 | Importing |
IV_ONLY_ACTIVE | Value transfer | Type reference (TYPE) | AS4FLAG | Flag (X or Blank) | 20091022 | ||
| 5 | Importing |
IV_PATTERN | Value transfer | Type reference (TYPE) | GRFN_API_SEARCH_PATTERN | API search pattern | 20100602 | ||
| 6 | Importing |
IV_REGULATION_ID | Value transfer | Type reference (TYPE) | GRFN_API_OBJECT_ID | Object ID | 20091022 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_GRFN_EXCEPTION |
Generic GRC API exception | 20091022 |
Method RETRIEVE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ES_SURVEY | Call by reference | Type reference (TYPE) | GRPC_S_API_SURVEY_DATA | Survey Template | 20091022 | ||
| 2 | Exporting |
ET_MAPPING | Call by reference | Type reference (TYPE) | GRFN_T_API_SRV_QUESTION_MAP | Survey Question Mapping | 20131003 | ||
| 3 | Exporting |
ET_QUESTION | Call by reference | Type reference (TYPE) | GRPC_T_API_SRV_QUESTION_DATA | Survey Question | 20091022 | ||
| 4 | Exporting |
ET_SURVEY_CHOICE | Call by reference | Type reference (TYPE) | GRFN_T_API_SRV_QUESTION_CHOICE | Survey Question Choices | 20100330 | ||
| 5 | Exporting |
EV_VALUATION_DATA | Call by reference | Type reference (TYPE) | GRFN_VALUATION_DATA | Valuation Data | 20100407 | ||
| 6 | Importing |
IV_ALL_CHOICES | Value transfer | Type reference (TYPE) | AS4FLAG | PRovide all choices (not only survey overrided) | 20100402 | ||
| 7 | Importing |
IV_EDITABLE | Value transfer | Type reference (TYPE) | GRFN_BOOLEAN | Boolean | 20091022 | ||
| 8 | Importing |
IV_QUESTION_DETAILS | Value transfer | Type reference (TYPE) | GRFN_BOOLEAN | ABAP_FALSE | Boolean | 20091022 | |
| 9 | Importing |
IV_REGULATION_ID | Value transfer | Type reference (TYPE) | GRFN_API_OBJECT_ID | Object ID | 20091022 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_GRFN_EXCEPTION |
Generic GRC API exception | 20091022 |
Method SURVEY_VALUATIONS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_LANGU | Value transfer | Type reference (TYPE) | SYLANGU | SY-LANGU | Language Key of Current Text Environment | 20100407 | |
| 2 | Importing |
IV_QCATEGORY | Value transfer | Type reference (TYPE) | GRPC_QCATEGORY | Question category | 20100407 | ||
| 3 | Returning |
RT_VALUATION | Value transfer | Type reference (TYPE) | GRFN_T_API_VALUATION | Valuations | 20100407 |
Method SURVEY_VALUATIONS on Interface IF_GRFN_API_SURVEY has no exception.
Method UPDATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IS_SURVEY | Call by reference | Type reference (TYPE) | GRPC_S_API_SURVEY_DATA | Survey Template | 20091022 | ||
| 2 | Importing |
IT_MAPPING | Call by reference | Type reference (TYPE) | GRFN_T_API_SRV_QUESTION_MAP | Survey Question Mapping | 20131003 | ||
| 3 | Importing |
IT_QUESTION | Call by reference | Type reference (TYPE) | GRPC_T_API_SRV_QUESTION_DATA | Survey Question | 20091022 | ||
| 4 | Importing |
IT_SURVEY_CHOICE | Call by reference | Type reference (TYPE) | GRFN_T_API_SRV_QUESTION_CHOICE | Survey Question Choices | 20100330 | ||
| 5 | Importing |
IV_FULL_CHECK | Value transfer | Type reference (TYPE) | AS4FLAG | Flag (X or Blank) | 20100402 | ||
| 6 | Importing |
IV_REGULATION_ID | Value transfer | Type reference (TYPE) | GRFN_API_OBJECT_ID | Object ID | 20091022 | ||
| 7 | Importing |
IV_VALUATION_DATA | Call by reference | Type reference (TYPE) | GRFN_VALUATION_DATA | Valuation Data | 20100407 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_GRFN_EXCEPTION |
Generic GRC API exception | 20091022 |
History
| Last changed by/on | SAP | 20141106 |
| SAP Release Created in | 600 |
