SAP ABAP Interface IF_SIW_SERVICE_API (API for Projects)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-ESI-SIW (Application Component) Service Implementation Workbench
⤷
S_SIW_API (Package) API for Service Implementation Workbench
SAP_BASIS (Software Component) SAP Basis Component⤷
BC-ESI-SIW (Application Component) Service Implementation Workbench⤷
S_SIW_API (Package) API for Service Implementation Workbench
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_SIW_SERVICE_API | SIW API for Non-Service | 20091113 |
Properties
| Interface | IF_SIW_SERVICE_API | |
| Short Description | API for Projects |
General Data
| Package | S_SIW_API | API for Service Implementation Workbench |
| Created | 20091113 | SAP |
| Last changed | 20110908 | SAP |
| 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 IF_SIW_SERVICE_API has no interface.
Friends
Interface IF_SIW_SERVICE_API has no friend.
Attributes
Interface IF_SIW_SERVICE_API has no attribute.
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CHECK |
Instance method | Public | Method | Executes Some Project Checks and Updates the Status | 20110121 |
| 2 | CHECK_EXISTENCE |
Instance method | Public | Method | Check the Existence of an SIW Project | 20091113 |
| 3 | CREATE |
Instance method | Public | Method | Create SOA Service via SIW, incl. Generation of Objects | 20091113 |
| 4 | DELETE |
Instance method | Public | Method | Delete a SOA Service including SIW Project Information | 20091113 |
| 5 | GET_CURRENT_STATUS |
Instance method | Public | Method | Get the Current Status of an SIW Project | 20110121 |
| 6 | GET_DETAIL |
Instance method | Public | Method | Get the Details of an SIW Project | 20091113 |
| 7 | GET_STATE |
Instance method | Public | Method | Get the Status of an SIW Project | 20091113 |
| 8 | UPDATE |
Instance method | Public | Method | Update SOA Service via SIW, incl. Generation of Objects | 20091113 |
Events
Interface IF_SIW_SERVICE_API has no event.
Types
Interface IF_SIW_SERVICE_API has no local type.
Method Signatures
Method CHECK Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
I_FLG_CHECK_GEN_OBJECTS | Call by reference | Type reference (TYPE) | SIW_DTE_FLG_DEEP_OBJECTS_CHECK | Execute Check of Generated Objects (Deep Check)? | 20110121 | ||
| 2 | Importing |
I_FLG_CHECK_WITH_ABAP_UNIT | Call by reference | Type reference (TYPE) | SIW_DTE_FLAG_ABAP_UNIT | Execute ABAP Unit Tests of Generated Objects? | 20110121 | ||
| 3 | Importing |
I_PROJECT_ID | Call by reference | Type reference (TYPE) | SIW_DTE_PROJECT_ID | SIW Project ID | 20110121 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_SIW_AUTHORISATION_FAILURE |
Authorisation Failure | 20110121 | |
| 2 | CX_SIW_EXECUTION_ERROR |
Execution Error | 20110121 | |
| 3 | CX_SIW_NOT_FOUND |
Not Existing Object or Information | 20110121 |
Method CHECK_EXISTENCE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
I_PROJECT_ID | Call by reference | Type reference (TYPE) | SIW_DTE_PROJECT_ID | SIW Project ID | 20091113 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SIW_NOT_FOUND |
SIW project does not exist | 20091113 |
Method CREATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
I_CONTEXT_PRESET | Call by reference | Type reference (TYPE) | SIW_TAB_API_PROPERTY | Context Variables (Preset before set up of Constr. Plan) | 20100208 | ||
| 2 | Importing |
I_CONTEXT_VARIABLES | Call by reference | Type reference (TYPE) | SIW_TAB_API_PROPERTY | List of Context Variables | 20091117 | ||
| 3 | Importing |
I_GEN_SETTINGS | Call by reference | Type reference (TYPE) | SIW_STR_GEN_SETTINGS_API | Generation Settings | 20091120 | ||
| 4 | Importing |
I_PROJECT_DATA | Call by reference | Type reference (TYPE) | SIW_STR_API_PROJECT_ATTR | Attributes of SIW Project (API Structure) | 20091113 | ||
| 5 | Importing |
I_SERVICE_DATA | Call by reference | Type reference (TYPE) | SIW_STR_API_SERVICE_DATA | Service related Information | 20091113 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SIW_AUTHORISATION_FAILURE |
20101207 | ||
| 2 | CX_SIW_EXECUTION_ERROR |
Error during execution | 20091113 |
Method DELETE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
I_PROJECT_ID | Call by reference | Type reference (TYPE) | SIW_DTE_PROJECT_ID | Project ID | 20091113 | ||
| 2 | Importing |
I_TAB_KEEP_PIECES | Call by reference | Type reference (TYPE) | SIW_TAB_RNG_PIECE_ID | List of Generated Objects not to be deleted | 20091113 | ||
| 3 | Importing |
I_TRANSPORT_SETTINGS | Call by reference | Type reference (TYPE) | SIW_STR_TRANSPORT_SETTINGS | Transport options | 20091113 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SIW_AUTHORISATION_FAILURE |
20101207 | ||
| 2 | CX_SIW_EXECUTION_ERROR |
Error during execution | 20091113 | |
| 3 | CX_SIW_NOT_FOUND |
SIW project does not exist | 20091113 |
Method GET_CURRENT_STATUS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
I_PROJECT_ID | Call by reference | Type reference (TYPE) | SIW_DTE_PROJECT_ID | SIW Project ID | 20110121 | ||
| 2 |  Returning |
R_STATUS | Value transfer | Object reference (TYPE REF TO) | IF_SIW_STATUS_GETTER | Read Interface for SIW Status (Including Substatus) | 20110121 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SIW_AUTHORISATION_FAILURE |
Authorisation Failure | 20110121 | |
| 2 | CX_SIW_EXECUTION_ERROR |
Execution Error | 20110121 | |
| 3 | CX_SIW_NOT_FOUND |
Not Existing Object or Information | 20110121 |
Method GET_DETAIL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
E_CONTEXT_VARIABLES | Call by reference | Type reference (TYPE) | SIW_TAB_API_PROPERTY | Table of Context Variables | 20091117 | ||
| 2 | Exporting |
E_GENERATED_OBJECTS | Call by reference | Type reference (TYPE) | SIW_TAB_PIECE_ATTR_API | Table of Generated Objects | 20091117 | ||
| 3 | Exporting |
E_OBJECTS_PREVIEW | Call by reference | Type reference (TYPE) | SIW_TAB_PIECE_ATTR_API | Preview of Objects that would be generated | 20100208 | ||
| 4 | Exporting |
E_PROJECT_HEADER | Call by reference | Type reference (TYPE) | SIW_STR_PROJECT_ATTR_EXT | Attributes of the SIW Project | 20091113 | ||
| 5 | Importing |
I_PROJECT_ID | Call by reference | Type reference (TYPE) | SIW_DTE_PROJECT_ID | Project ID | 20091113 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SIW_AUTHORISATION_FAILURE |
20101207 | ||
| 2 | CX_SIW_EXECUTION_ERROR |
Error during execution | 20091113 | |
| 3 | CX_SIW_NOT_FOUND |
SIW project does not exist | 20091113 |
Method GET_STATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
E_MAPPING_CHECK_RESULT | Call by reference | Type reference (TYPE) | SIW_DTE_MAPPING_CHECK_RESULT | Mapping Check Result - Return Code | 20091221 | ||
| 2 | Exporting |
E_OBJECT_CHECK_RESULT | Call by reference | Type reference (TYPE) | SIW_DTE_OBJECT_CHECK_RESULT | Object Check Result - Return Code | 20100105 | ||
| 3 | Exporting |
E_OVERALL_RESULT | Call by reference | Type reference (TYPE) | SIW_DTE_CHECK_RESULT | Overall Check Result - Return Code | 20091113 | ||
| 4 | Exporting |
E_OVERALL_STATE_TEXT | Call by reference | Type reference (TYPE) | SIW_DTE_STATUS_TEXT | Overall Check Result - Text | 20091113 | ||
| 5 | Exporting |
E_PROJECT_STATE_ID | Call by reference | Type reference (TYPE) | SIW_DTE_STATE | Project Status (Code) | 20100208 | ||
| 6 | Exporting |
E_PROJECT_STATE_TEXT | Call by reference | Type reference (TYPE) | SIW_DTE_STATUS_TEXT | Project Status (Text) | 20100208 | ||
| 7 | Exporting |
E_UNIT_TEST_RESULT | Call by reference | Type reference (TYPE) | SIW_DTE_UNIT_TEST_RESULT | Unit Test Result - Return Code | 20091123 | ||
| 8 | Importing |
I_PROJECT_ID | Call by reference | Type reference (TYPE) | SIW_DTE_PROJECT_ID | Project ID | 20091113 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SIW_AUTHORISATION_FAILURE |
20101207 | ||
| 2 | CX_SIW_EXECUTION_ERROR |
Object does not exist | 20091218 |
Method UPDATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
I_CONTEXT_VARIABLES | Call by reference | Type reference (TYPE) | SIW_TAB_API_PROPERTY | SIW Table type for properties within the API | 20091117 | ||
| 2 | Importing |
I_GEN_SETTINGS | Call by reference | Type reference (TYPE) | SIW_STR_GEN_SETTINGS_API | Generation Settings | 20091120 | ||
| 3 | Importing |
I_PROJECT_DATA | Call by reference | Type reference (TYPE) | SIW_STR_API_PROJECT_UPDATE | Update Structure for Project Header Information | 20110317 | ||
| 4 | Importing |
I_PROJECT_DATA_UPD | Call by reference | Type reference (TYPE) | SIW_STR_API_PROJECT_UPD_FLG | Flags for Update Structure | 20110317 | ||
| 5 | Importing |
I_PROJECT_ID | Call by reference | Type reference (TYPE) | SIW_DTE_PROJECT_ID | Attributes of SIW project (API structure) | 20091118 | ||
| 6 | Importing |
I_SERVICE_DATA | Call by reference | Type reference (TYPE) | SIW_STR_API_SERVICE_UPD | Deploy web service? (X=True, -=False, Space=Unknown) | 20091113 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SIW_AUTHORISATION_FAILURE |
20101207 | ||
| 2 | CX_SIW_EXECUTION_ERROR |
Error during execution | 20091113 | |
| 3 | CX_SIW_NOT_FOUND |
SIW project does not exist | 20091113 |
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in | 730 |
