SAP ABAP Class CL_SIW_PROJECT_API (SIW API for Non-Service)

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

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SIW_PROJECT_API	API for Projects	20090824

Properties

Class	CL_SIW_PROJECT_API
Short Description	SIW API for Non-Service
Super Class
Instantiability of a Class	0	Private
Final	☐

General Data

Message Class
Program status
Category	0
Package	S_SIW_API	API for Service Implementation Workbench
Created	20090824	SAP
Last change	20130531	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...

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_SIW_PROJECT_API	☐	☐	API for Projects	20090824

Friends

#	Friend	Modeled only	Created on	Description
1	CL_SIW_SERVICE_API	☐	20091120	SIW API for Non-Service

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MO_LOG	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_SIW_LOG		Logging Interface of SIW	20101014

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK	Instance method	Private	Method		20110121
2	CHECK_EXISTENCE	Instance method	Private	Method		20091120
3	CREATE	Instance method	Private	Method		20091120
4	DELETE	Instance method	Private	Method		20091120
5	FILL_OBJECTS_PREVIEW	Instance method	Private	Method	Fill Objects' Preview	20100208
6	GENERATE	Instance method	Private	Method		20091012
7	GET_CURRENT_STATUS	Instance method	Private	Method		20110121
8	GET_DETAIL	Instance method	Private	Method		20091120
9	GET_STATE	Instance method	Private	Method		20091120
10	INIT	Instance method	Private	Method	Initialize API Instance	20091113
11	INIT_GEN_SETTINGS	Static method	Protected	Method	Initialize Generation Settings	20100916
12	INIT_TRANSPORT_SETTINGS	Static method	Private	Method	Initialize Transport Settings	20091120
13	MAP_DDIC_TO_CONTEXT	Instance method	Private	Method	Generic Context Filler for a DDIC Structure	20100915
14	MAP_PRESET_2_PROJECT_DATA	Instance method	Protected	Method	Map Preset Variables to Project Header Data	20100916
15	PREPARE_GENERATION	Static method	Protected	Method	Prepare Generation	20100916
16	RELOAD	Instance method	Private	Method		20110121
17	RESET	Instance method	Private	Method		20110121
18	SAVE	Instance method	Private	Method		20091120
19	S_ASSERT_VALID_PROJECT_ID	Static method	Protected	Method	Assert thats the Project ID is Valid	20101203
20	S_CHECK_CREATION_PREREQUISITES	Static method	Protected	Method	Checks the Creation Prerequisites	20101208
21	S_CREATE_INSTANCE	Static method	Public	Method	Create API Instance	20091113
22	S_GET_LOCKED_PROJECT_FOR_UPD	Static method	Protected	Method	Returns an Existing, Registered and Locked Project	20101208
23	S_GET_PROJECT_TO_READ	Static method	Protected	Method	Returns an Existing, Registered Project	20101208
24	S_GET_REGISTERED_PROJECT	Static method	Protected	Method	Returns Project, only When Registered	20101129
25	S_LOCK_PROJECT	Static method	Protected	Method	Locks the Project	20101208
26	S_REGISTER_PROJECT	Static method	Protected	Method	Registers a Project	20110420
27	S_TRY_UNLOCK_PROJECT	Static method	Protected	Method	Tries to unlock the Project	20101208
28	UPDATE	Instance method	Private	Method		20091120

Events

Class CL_SIW_PROJECT_API has no event.

Types

Class CL_SIW_PROJECT_API has no local type.

Method Signatures

Method CHECK Signature

Method CHECK on class CL_SIW_PROJECT_API has no parameter.
Method CHECK on class CL_SIW_PROJECT_API has no exception.

Method CHECK_EXISTENCE Signature

Method CHECK_EXISTENCE on class CL_SIW_PROJECT_API has no parameter.
Method CHECK_EXISTENCE on class CL_SIW_PROJECT_API has no exception.

Method CREATE Signature

Method CREATE on class CL_SIW_PROJECT_API has no parameter.
Method CREATE on class CL_SIW_PROJECT_API has no exception.

Method DELETE Signature

Method DELETE on class CL_SIW_PROJECT_API has no parameter.
Method DELETE on class CL_SIW_PROJECT_API has no exception.

Method FILL_OBJECTS_PREVIEW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_PROJECT	Call by reference	☐	Object reference (TYPE REF TO)	IF_SIW_PROJECT		Project (commons)	20100302
2	Returning	R_OBJECTS_PREVIEW	Value transfer	☐	Type reference (TYPE)	SIW_TAB_PIECE_ATTR_API		SIW: List of Objects with Attributes (API)	20100208

#	Exception	Resumable	Description	Created on
1	CX_SIW_EXECUTION_ERROR	☐	Execution Error	20100208

Method GENERATE Signature

Method GENERATE on class CL_SIW_PROJECT_API has no parameter.
Method GENERATE on class CL_SIW_PROJECT_API has no exception.

Method GET_CURRENT_STATUS Signature

Method GET_CURRENT_STATUS on class CL_SIW_PROJECT_API has no parameter.
Method GET_CURRENT_STATUS on class CL_SIW_PROJECT_API has no exception.

Method GET_DETAIL Signature

Method GET_DETAIL on class CL_SIW_PROJECT_API has no parameter.
Method GET_DETAIL on class CL_SIW_PROJECT_API has no exception.

Method GET_STATE Signature

Method GET_STATE on class CL_SIW_PROJECT_API has no parameter.
Method GET_STATE on class CL_SIW_PROJECT_API has no exception.

Method INIT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_LOG	Call by reference	☐	Object reference (TYPE REF TO)	IF_SIW_LOG		Logging Interface of SIW	20091113

Method INIT on class CL_SIW_PROJECT_API has no exception.

Method INIT_GEN_SETTINGS 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			20100916
2	Returning	R_ADAPTED_SETTINGS	Value transfer	☐	Type reference (TYPE)	SIW_STR_GEN_SETTINGS			20100916

Method INIT_GEN_SETTINGS on class CL_SIW_PROJECT_API has no exception.

Method INIT_TRANSPORT_SETTINGS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_TRANSPORT_SETTINGS	Call by reference	☐	Type reference (TYPE)	SIW_STR_TRANSPORT_SETTINGS		SIW: Transport Settings	20091120

Method INIT_TRANSPORT_SETTINGS on class CL_SIW_PROJECT_API has no exception.

Method MAP_DDIC_TO_CONTEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_CONTEXT_VAR	Call by reference	☐	Type reference (TYPE)	SIW_TAB_API_PROPERTY		SIW Table Type for Properties within the API	20100915
2	Importing	I_DATA	Call by reference	☐	Type reference (TYPE)	ANY		Any Data Structure	20100915
3	Importing	I_DATA_TYPE	Call by reference	☐	Type reference (TYPE)	TABNAME		Table Name	20100915

Method MAP_DDIC_TO_CONTEXT on class CL_SIW_PROJECT_API has no exception.

Method MAP_PRESET_2_PROJECT_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_CONTEXT_PRESET	Call by reference	☐	Type reference (TYPE)	SIW_TAB_API_PROPERTY			20100916
2	Changing	C_OCCURRENCE	Call by reference	☐	Type reference (TYPE)	SIW_DTE_OCCURRENCE			20100916
3	Changing	C_PROJECT_DATA	Call by reference	☐	Type reference (TYPE)	SIW_STR_PROJECT_ATTR_EXT		Attributes of an SIW project (with Description)	20100916
4	Changing	C_VI_DATA	Call by reference	☐	Type reference (TYPE)	SIW_STR_API_L0			20100916

Method MAP_PRESET_2_PROJECT_DATA on class CL_SIW_PROJECT_API has no exception.

Method PREPARE_GENERATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_LOG	Call by reference	☐	Object reference (TYPE REF TO)	IF_SIW_LOG			20100916
2	Importing	I_OVERWRITE_EXT_OBJ	Call by reference	☐	Type reference (TYPE)	SIW_DTE_OVR_EXT			20100916
3	Importing	I_PROJECT	Call by reference	☐	Object reference (TYPE REF TO)	IF_SIW_PROJECT			20100916
4	Returning	R_OBJECTS4DELETION	Value transfer	☐	Type reference (TYPE)	IF_SIW_IMPL=>TAB_PRODUCED_PIECES			20100916

#	Exception	Resumable	Description	Created on
1	CX_SIW_EXECUTION_ERROR	☐	Execution Error	20100916

Method RELOAD Signature

Method RELOAD on class CL_SIW_PROJECT_API has no parameter.
Method RELOAD on class CL_SIW_PROJECT_API has no exception.

Method RESET Signature

Method RESET on class CL_SIW_PROJECT_API has no parameter.
Method RESET on class CL_SIW_PROJECT_API has no exception.

Method SAVE Signature

Method SAVE on class CL_SIW_PROJECT_API has no parameter.
Method SAVE on class CL_SIW_PROJECT_API has no exception.

Method S_ASSERT_VALID_PROJECT_ID 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	20101203

Method S_ASSERT_VALID_PROJECT_ID on class CL_SIW_PROJECT_API has no exception.

Method S_CHECK_CREATION_PREREQUISITES 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	20101208

#	Exception	Resumable	Description	Created on
1	CX_SIW_CALL_ERROR	☐	Error during Call	20101208
2	CX_SIW_EXECUTION_ERROR	☐	Error during execution	20101208

Method S_CREATE_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_LOG	Call by reference	☑	Object reference (TYPE REF TO)	IF_SIW_LOG		Logging Interface of SIW	20091113
2	Returning	R_SIW_PROJECT_API	Value transfer	☐	Object reference (TYPE REF TO)	IF_SIW_PROJECT_API		SIW: API for projects	20091113

Method S_CREATE_INSTANCE on class CL_SIW_PROJECT_API has no exception.

Method S_GET_LOCKED_PROJECT_FOR_UPD 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	20101208
2	Returning	R_PROJECT	Value transfer	☐	Object reference (TYPE REF TO)	IF_SIW_PROJECT		Project	20101208

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

Method S_GET_PROJECT_TO_READ 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	20101208
2	Returning	R_PROJECT	Value transfer	☐	Object reference (TYPE REF TO)	IF_SIW_PROJECT		Project	20101208

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

Method S_GET_REGISTERED_PROJECT 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	20101129
2	Returning	R_PROJECT	Value transfer	☐	Object reference (TYPE REF TO)	IF_SIW_PROJECT		Project	20101129

Method S_GET_REGISTERED_PROJECT on class CL_SIW_PROJECT_API has no exception.

Method S_LOCK_PROJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_REF_PROJECT	Call by reference	☐	Object reference (TYPE REF TO)	IF_SIW_PROJECT		Project	20101208

#	Exception	Resumable	Description	Created on
1	CX_SIW_AUTHORISATION_FAILURE	☐	Missing authorization	20101208
2	CX_SIW_EXECUTION_ERROR	☐	Error during execution	20101208

Method S_REGISTER_PROJECT 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	20110420
2	Returning	R_PROJECT	Value transfer	☐	Object reference (TYPE REF TO)	IF_SIW_PROJECT		Project	20110420

#	Exception	Resumable	Description	Created on
1	CX_SIW_AUTHORISATION_FAILURE	☐	Missing Authorization	20110420
2	CX_SIW_EXECUTION_ERROR	☐	Execution Error	20110420
3	CX_SIW_NOT_FOUND	☐	Project Exists Not	20110420

Method S_TRY_UNLOCK_PROJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_REF_PROJECT	Call by reference	☐	Object reference (TYPE REF TO)	IF_SIW_PROJECT		Project	20101208

Method S_TRY_UNLOCK_PROJECT on class CL_SIW_PROJECT_API has no exception.

Method UPDATE Signature

Method UPDATE on class CL_SIW_PROJECT_API has no parameter.
Method UPDATE on class CL_SIW_PROJECT_API has no exception.

History

Last changed by/on	SAP	20130531
SAP Release Created in	730