SAP ABAP Class IF_SIW_PROJECT_API ( API for Projects)

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	CL_SIW_PROJECT_API	SIW API for Non-Service	20090824

Properties

Class	IF_SIW_PROJECT_API
Short Description	API for Projects
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package
Created	20090824	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☐
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)
2	IF_SIW_IMPL	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
3	IF_SIW_VARIABLE	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

Class IF_SIW_PROJECT_API has no interface implemented.

Friends

Class IF_SIW_PROJECT_API has no friend class.

Attributes

Class IF_SIW_PROJECT_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	20110120
2	CHECK_EXISTENCE	Instance method	Public	Method	Check the Existence of an SIW Project	20091113
3	CREATE	Instance method	Public	Method	Create SIW Project, with Context, no Generation	20091113
4	DELETE	Instance method	Public	Method	Delete an SIW Project	20091113
5	GENERATE	Instance method	Public	Method	Generate Objects	20091012
6	GET_CURRENT_STATUS	Instance method	Public	Method	Get the Current Status of an SIW Project	20110120
7	GET_DETAIL	Instance method	Public	Method	Get the Details of an SIW Project	20091113
8	GET_STATE	Instance method	Public	Method	Obsolete: Use CHECK and GET_CURRENT_STATUS instead	20091113
9	RELOAD	Instance method	Public	Method	Loads a Project from Database; Resets the Project	20101203
10	RESET	Instance method	Public	Method	Undo Creation or Update of a specific Project	20091123
11	SAVE	Instance method	Public	Method	Obsolete: Not Required Functionality	20091113
12	UPDATE	Instance method	Public	Method	Update an SIW Project	20091113

Events

Class IF_SIW_PROJECT_API has no event.

Types

Class IF_SIW_PROJECT_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)?	20110120
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?	20110120
3	Importing	I_PROJECT_ID	Call by reference	☐	Type reference (TYPE)	SIW_DTE_PROJECT_ID		SIW Project ID	20110120

#	Exception	Resumable	Description	Created on
1	CX_SIW_AUTHORISATION_FAILURE	☐	Authorisation Failure	20110120
2	CX_SIW_EXECUTION_ERROR	☐	Execution Error	20110120
3	CX_SIW_NOT_FOUND	☐	Not Existing Object or Information	20110120

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		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 for Project Creation (Configuration Input)	20100208
2	Importing	I_CONTEXT_VARIABLES	Call by reference	☑	Type reference (TYPE)	SIW_TAB_API_PROPERTY		Configuration Context Variables to be Changed	20091117
3	Importing	I_PROJECT_DATA	Call by reference	☐	Type reference (TYPE)	SIW_STR_API_PROJECT_ATTR		Attributes of SIW Project (API structure)	20091113

#	Exception	Resumable	Description	Created on
1	CX_SIW_AUTHORISATION_FAILURE	☐	Missing authorization	20101207
2	CX_SIW_CALL_ERROR	☐	Method Call is not Allowed	20101202
3	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 that Shouldn't be Deleted	20091113
3	Importing	I_TRANSPORT_SETTINGS	Call by reference	☑	Type reference (TYPE)	SIW_STR_TRANSPORT_SETTINGS		Transport Options	20091120

#	Exception	Resumable	Description	Created on
1	CX_SIW_AUTHORISATION_FAILURE	☐	Missing authorization	20101207
2	CX_SIW_EXECUTION_ERROR	☐	Error during execution	20091113
3	CX_SIW_NOT_FOUND	☐	SIW project does not exist	20091113

Method GENERATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_GEN_SETTINGS	Call by reference	☑	Type reference (TYPE)	SIW_STR_GEN_SETTINGS_API		Generation and Transport Settings	20091012
2	Importing	I_PROJECT_ID	Call by reference	☐	Type reference (TYPE)	SIW_DTE_PROJECT_ID		Project ID	20091014

#	Exception	Resumable	Description	Created on
1	CX_SIW_AUTHORISATION_FAILURE	☐	Missing authorization	20101207
2	CX_SIW_EXECUTION_ERROR	☐	Error during execution	20091014
3	CX_SIW_NOT_FOUND	☐	SIW project does not exist	20091014

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	20110120
2	Returning	R_STATUS	Value transfer	☐	Object reference (TYPE REF TO)	IF_SIW_STATUS_GETTER		Read Interface for SIW Status (Including Substatus)	20110120

#	Exception	Resumable	Description	Created on
1	CX_SIW_AUTHORISATION_FAILURE	☐	Authorisation Failure	20110120
2	CX_SIW_EXECUTION_ERROR	☐	Execution Error	20110120
3	CX_SIW_NOT_FOUND	☐	Not Existing Object or Information	20110120

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_API_PROJECT_ATTR		Attributes of SIW project	20091113
5	Importing	I_ENRICH_CONTEXT_FROM_HEADER	Call by reference	☐	Type reference (TYPE)	SIW_DTE_ENRICH_CONTEXT	SPACE	Shall Project Header Attributes be Part of the Context?	20100915
6	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	☐	Missing authorization	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 Project Check Result - Return Code	20091113
4	Exporting	E_OVERALL_STATE_TEXT	Call by reference	☐	Type reference (TYPE)	SIW_DTE_PROJECT_STATUS_TEXT		Overall Project Check Result Text	20091113
5	Exporting	E_PROJECT_STATE_ID	Call by reference	☐	Type reference (TYPE)	SIW_DTE_PROJECT_STATE		Project Status	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	☐	Missing authorization	20101207
2	CX_SIW_EXECUTION_ERROR	☐	Error in Execution	20091218
3	CX_SIW_NOT_FOUND	☐	Not Existing Object or Information	20110121

Method RELOAD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_PROJECT_ID	Value transfer	☐	Type reference (TYPE)	SIW_DTE_PROJECT_ID			20101203

#	Exception	Resumable	Description	Created on
1	CX_SIW_AUTHORISATION_FAILURE	☐	Missing authorization	20101207
2	CX_SIW_EXECUTION_ERROR	☐	Error during execution	20101203
3	CX_SIW_NOT_FOUND	☐	SIW project does not exist	20101203

Method RESET 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	20091123

#	Exception	Resumable	Description	Created on
1	CX_SIW_AUTHORISATION_FAILURE	☐	Missing authorization	20101207
2	CX_SIW_EXECUTION_ERROR	☐	Error during execution	20091123
3	CX_SIW_NOT_FOUND	☐	SIW project does not exist	20091123

Method SAVE 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

#	Exception	Resumable	Description	Created on
1	CX_SIW_AUTHORISATION_FAILURE	☐	Missing authorization	20101207
2	CX_SIW_EXECUTION_ERROR	☐	Error during execution	20091113
3	CX_SIW_NOT_FOUND	☐	SIW project does not exist	20091113

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		Configuration Context Variables to be Changed	20091117
2	Importing	I_PROJECT_DATA	Call by reference	☑	Type reference (TYPE)	SIW_STR_API_PROJECT_UPDATE		Update Structure for Project Header Information	20110317
3	Importing	I_PROJECT_DATA_UPD	Call by reference	☑	Type reference (TYPE)	SIW_STR_API_PROJECT_UPD_FLG		Flags for Update Structure	20110317
4	Importing	I_PROJECT_ID	Call by reference	☑	Type reference (TYPE)	SIW_DTE_PROJECT_ID		Attributes of SIW project (API structure)	20091118

#	Exception	Resumable	Description	Created on
1	CX_SIW_AUTHORISATION_FAILURE	☐	Missing authorization	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