SAP ABAP Class CL_FOPC_NOTE_API (SOA: Notes)

Hierarchy

☛ FINBASIS (Software Component) Fin. Basis
   ⤷ FIN-CGV-MIC (Application Component) Management of Internal Controls
     ⤷ FOPC_CASE_MANAGEMENT (Package) Specific to Case Management

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_FOPC_NOTES_API	SOA: Notes API	20040528

Properties

Class	CL_FOPC_NOTE_API
Short Description	SOA: Notes
Super Class
Instantiability of a Class	1	Protected
Final	☐

General Data

Message Class
Program status
Category	0
Package	FOPC_CASE_MANAGEMENT	Specific to Case Management
Created	20031202	SAP
Last change	20041006	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	CL_FOPC_NOTE_API	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
2	IF_SRM	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
3	SRMGS	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_FOPC_NOTES_API	☐	☐	SOA: Notes API	20040528

Friends

Class CL_FOPC_NOTE_API has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_DESCRIPTION	Constant	Private	☐	Type reference (TYPE)	STRING	'TEXT'	Default Description	20031203
2	GC_RMS_ID	Constant	Public	☐	Type reference (TYPE)	STRING	'FOPC_SOA'	RMS ID	20031202
3	GC_SEMANTIC_ID	Constant	Private	☐	Type reference (TYPE)	STRING	'FOPC_SOA'	Default Semantic ID	20031203
4	GC_SPS_ID	Constant	Public	☐	Type reference (TYPE)	STRING	'FOPC_SPS_NOTE'	SPS ID	20031202
5	G_ASCII_CONTENT	Instance attribute	Public	☑	Type reference (TYPE)	SRMGS_ASCII_CONTENT		Note Contents (Line ... )	20031202
6	G_CLIENT_MANAGER	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_SRM_SRM_CLIENT_MANAGER		Basis for Client Manager	20031202
7	G_CLIENT_SERVICE	Static Attribute	Public	☑	Object reference (TYPE REF TO)	IF_SRM_SRM_CLIENT_SERVICE		Global Service	20031202
8	G_DELETED	Instance attribute	Private	☐	Type reference (TYPE)	XFELD		Case was deleted: Yes/No (X/space)	20031202
9	G_IS_CHANGED	Instance attribute	Private	☐	Type reference (TYPE)	SRMBOOLEAN		Notes Were Changed (Yes/No=X/Space)	20031216
10	G_IS_ENQUEUED	Instance attribute	Private	☐	Type reference (TYPE)	SRMBOOLEAN		Lock Set: Yes/No (X/Space)	20031216
11	G_NOTE_BACKEND	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_SRM_SP_NOTE		Note Back End	20031203
12	G_NOTE_POID	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_SRM_POID		POID of the Case	20031202
13	G_ROOT_OBJECT	Static Attribute	Public	☑	Object reference (TYPE REF TO)	IF_SRM_ROOT		Root Object	20031202
14	G_UPDATE_TASK	Instance attribute	Private	☐	Type reference (TYPE)	SRMBOOLEAN		Update Indicator	20031215

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CREATE_NOTE	Static method	Public	Method	Notes: Create	20031202
2	DELETE	Instance method	Public	Method	Notes: Save	20031204
3	DEQUEUE	Instance method	Public	Method	Remove Lock from Case	20031204
4	ENQUEUE	Instance method	Public	Method	Lock Case	20031204
5	GET_CONTENT	Instance method	Public	Method	Get Contents of Notes	20031202
6	GET_NOTE	Static method	Public	Method	Create NOTE-API Object	20031202
7	GET_SRM_POID	Instance method	Public	Method	Get SRM_POID of the Note	20031203
8	GET_UPDATE_TASK	Instance method	Public	Method	Read Update Switch	20031215
9	IS_CHANGED	Instance method	Public	Method	Whether Note is Changed (X/Space=Yes/No)	20031216
10	IS_ENQUEUED	Instance method	Public	Method	Whether Note is Enqueued (X/Space=Yes/No)	20031216
11	SAVE	Instance method	Public	Method	Notes: Save	20031202
12	SET_CONTENT	Instance method	Public	Method	Set Note Contents	20031202
13	SET_UPDATE_TASK	Instance method	Private	Method	Set Update Indicator	20031215
14	START_FRAMEWORK	Static method	Protected	Method	Initialization of the Framework etc.	20031202
15	STR_TO_TAB	Static method	Private	Method	Convert STRING into Table SRMGS_ASCII_CONTENT	20031203
16	TAB_TO_STR	Static method	Private	Method	Convert Table SRMGS_ASCII_CONTENT into STRING	20031203

Events

Class CL_FOPC_NOTE_API has no event.

Types

Class CL_FOPC_NOTE_API has no local type.

Method Signatures

Method CREATE_NOTE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_RMS_ID	Value transfer	☑	Type reference (TYPE)	STRING		RMS ID	20031202
2	Importing	IM_SPS_ID	Value transfer	☐	Type reference (TYPE)	STRING		SPS ID	20031202
3	Importing	IM_UPDATE_TASK	Value transfer	☐	Type reference (TYPE)	SRMBOOLEAN	IF_SRM=>TRUE	Verbuchungsschalter (initial=keine Verbuchung, X=Verbuchung)	20031215
4	Returning	R_NOTE	Value transfer	☐	Object reference (TYPE REF TO)	CL_FOPC_NOTE_API		SOA: Notizen	20031203

#	Exception	Resumable	Description	Created on
1	CX_FOPC_CASE	☐	SOA: Fall	20031203

Method DELETE Signature

Method DELETE on class CL_FOPC_NOTE_API has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_FOPC_CASE	☐	SOA: Fall	20031204

Method DEQUEUE Signature

Method DEQUEUE on class CL_FOPC_NOTE_API has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_FOPC_CASE	☐	SOA: Fall	20031204

Method ENQUEUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_MODE	Call by reference	☐	Type reference (TYPE)	STRING	IF_SRM_SP_ENQUEUE=>MODE_EXCLUSIVE		20031204
2	Importing	IM_SCOPE	Call by reference	☐	Type reference (TYPE)	STRING	IF_SRM_SP_ENQUEUE=>SCOPE_DIALOG		20031204

#	Exception	Resumable	Description	Created on
1	CX_FOPC_CASE	☐	SOA: Fall	20031204

Method GET_CONTENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_ASCII_CONTENT	Value transfer	☐	Type reference (TYPE)	STRING		Note Content	20031203

Method GET_CONTENT on class CL_FOPC_NOTE_API has no exception.

Method GET_NOTE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_DOC_ID	Value transfer	☑	Type reference (TYPE)	SRMGS_DOC_ID		DOC_ID In SRM_LIST_POID	20031202
2	Importing	IM_RMS_ID	Value transfer	☑	Type reference (TYPE)	STRING		RMS ID	20031202
3	Importing	IM_SPS_ID	Value transfer	☑	Type reference (TYPE)	STRING		SPS ID	20031202
4	Importing	IM_SP_POID	Value transfer	☑	Type reference (TYPE)	SRM_LIST_POID		List: POID Parameter Values	20031202
5	Importing	IM_SRM_POID	Value transfer	☑	Object reference (TYPE REF TO)	IF_SRM_POID		POID	20031202
6	Importing	IM_UPDATE_TASK	Value transfer	☐	Type reference (TYPE)	SRMBOOLEAN	IF_SRM=>TRUE	Verbuchungsschalter (initial=keine Verbuchung, X=Verbuchung)	20031215
7	Importing	IM_VARIANT	Value transfer	☐	Type reference (TYPE)	SRMGS_DOC_VAR_ID	0	VARIANT In SRM_LIST_POID	20031202
8	Importing	IM_VERSION	Value transfer	☐	Type reference (TYPE)	SRMGS_DOC_VER_ID	0	VERSION In SRM_LIST_POID	20031202
9	Returning	R_NOTE	Value transfer	☐	Object reference (TYPE REF TO)	CL_FOPC_NOTE_API		SOA: Notizen	20031203

#	Exception	Resumable	Description	Created on
1	CX_FOPC_CASE	☐	SOA: Fall	20031203

Method GET_SRM_POID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_SRM_POID	Value transfer	☐	Object reference (TYPE REF TO)	IF_SRM_POID		POID	20031203

Method GET_SRM_POID on class CL_FOPC_NOTE_API has no exception.

Method GET_UPDATE_TASK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_UPDATE_TASK	Value transfer	☐	Type reference (TYPE)	SRMBOOLEAN		Boolean: Mögliche Werte IF_SRM=>TRUE / FALSE	20031215

Method GET_UPDATE_TASK on class CL_FOPC_NOTE_API has no exception.

Method IS_CHANGED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_CHANGED	Value transfer	☐	Type reference (TYPE)	SRMBOOLEAN		X/Space=yes/no	20031216

Method IS_CHANGED on class CL_FOPC_NOTE_API has no exception.

Method IS_ENQUEUED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_ENQUEUED	Value transfer	☐	Type reference (TYPE)	SRMBOOLEAN		X/Space=yes/no	20031216

Method IS_ENQUEUED on class CL_FOPC_NOTE_API has no exception.

Method SAVE Signature

Method SAVE on class CL_FOPC_NOTE_API has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_FOPC_CASE	☐	SOA: Fall	20031203

Method SET_CONTENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_ASCII_CONTENT	Value transfer	☐	Type reference (TYPE)	STRING		Note Content	20031203

#	Exception	Resumable	Description	Created on
1	CX_FOPC_CASE	☐	SOA: Fall	20031216

Method SET_UPDATE_TASK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_UPDATE_TASK	Call by reference	☐	Type reference (TYPE)	SRMBOOLEAN		Boolean: Mögliche Werte IF_SRM=>TRUE / FALSE	20031215

#	Exception	Resumable	Description	Created on
1	CX_FOPC_CASE	☐	SOA: Fall	20031215

Method START_FRAMEWORK Signature

Method START_FRAMEWORK on class CL_FOPC_NOTE_API has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_SRM_INITIALIZATION	☐	Initialisierungsfehler (abstrakt)	20031203
2	CX_SRM_REGISTRATION_DATA	☐	SOA: Fall	20031203

Method STR_TO_TAB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_STR	Value transfer	☐	Type reference (TYPE)	STRING		String Value	20031203
2	Returning	R_TAB	Value transfer	☐	Type reference (TYPE)	SRMGS_ASCII_CONTENT		Table Value (SRMGS_ASCII_CONTENT)	20031203

Method STR_TO_TAB on class CL_FOPC_NOTE_API has no exception.

Method TAB_TO_STR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_TAB	Value transfer	☐	Type reference (TYPE)	SRMGS_ASCII_CONTENT		Table value (SRMGS_ASCII_CONTENT)	20031203
2	Returning	R_STR	Value transfer	☐	Type reference (TYPE)	STRING		String value	20031203

Method TAB_TO_STR on class CL_FOPC_NOTE_API has no exception.

History

Last changed by/on	SAP	20041006
SAP Release Created in	100