SAP ABAP Class CL_GOS_API_MSG (GOS API: Implementation of Type Message)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-GBT-GOS (Application Component) Generic Object Services
     ⤷ SGOS_API (Package) Access to GOS Attachment List for Externals

Properties

Class	CL_GOS_API_MSG
Short Description	GOS API: Implementation of Type Message
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class	SGOS_MSG
Program status	P	SAP Standard Production Program
Category	0
Package	SGOS_API	Access to GOS Attachment List for Externals
Created	20110307	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_GOS_API_MSG has no forward declaration.

Interfaces

Class CL_GOS_API_MSG has no interface implemented.

Friends

#	Friend	Modeled only	Created on	Description
1	CL_GOS_API	☐	20110428	GOS API: Access to External GOS Attachment List

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	C_URL_KEY	Constant	Private	☐	Type reference (TYPE)	CHAR5	'&KEY&'	URL Prefix	20110530

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	AUTHORITY_CHECK	Static method	Private	Method	Authorization Check	20110308
2	CHECK_EXIST	Static method	Protected	Method	Checks existence using object ID	20110506
3	DELETE_ITEM	Static method	Protected	Method	Deletes attachment	20110307
4	DELETE_LINK	Static method	Private	Method	Deletes relationship	20110506
5	GET_ITEM	Static method	Protected	Method	Reads attachment	20110307
6	GET_OBJ_ID	Static method	Protected	Method	Creates object ID	20110308
7	INSERT_ITEM	Static method	Protected	Method	Creates new attachment	20110322
8	OBJECT_LOCK	Static method	Private	Method	Lock Object (SOFM)	20110311
9	OBJECT_UNLOCK	Static method	Private	Method	Unlock Object (SOFM)	20110311
10	UPDATE_ITEM	Static method	Protected	Method	Changes attachment	20110307

Events

Class CL_GOS_API_MSG has no event.

Types

Class CL_GOS_API_MSG has no local type.

Method Signatures

Method AUTHORITY_CHECK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_ATTKEY	Call by reference	☐	Type reference (TYPE)	GOS_S_ATTKEY		GOS API: Schlüsselstruktur einer Anlage	20110324
2	Importing	IS_OBJECT	Call by reference	☐	Type reference (TYPE)	SIBFLPORB		GOS API: Objekt	20110310
3	Importing	IV_CMD	Call by reference	☐	Type reference (TYPE)	UI_FUNC		Funktionscode	20110308

#	Exception	Resumable	Description	Created on
1	CX_GOS_API	☐	GOS Anlagenliste	20110310

Method CHECK_EXIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ATTA_ID	Call by reference	☐	Type reference (TYPE)	GOS_ATTA_ID		SAPoffice: Mappe Inhalt (Key-Teil)	20110506
2	Returning	RV_EXIST	Value transfer	☐	Type reference (TYPE)	SAP_BOOL		boolsche Variable (X=true, space=false)	20110506

Method CHECK_EXIST on class CL_GOS_API_MSG has no exception.

Method DELETE_ITEM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_ATTKEY	Call by reference	☐	Type reference (TYPE)	GOS_S_ATTKEY		GOS API: Schlüsselstruktur einer Anlage	20110324
2	Importing	IS_OBJECT	Call by reference	☐	Type reference (TYPE)	SIBFLPORB		Lokale Persistente Objektreferenz - BOR kompatibel	20110309
3	Importing	IV_RELTYPE	Call by reference	☐	Type reference (TYPE)	OBLRELTYPE		Verknüpfungstyp	20110429
4	Returning	RV_COMMIT	Value transfer	☐	Type reference (TYPE)	FLAG		Commit benötigt	20110311

#	Exception	Resumable	Description	Created on
1	CX_GOS_API	☐	GOS Anlagenliste	20110308

Method DELETE_LINK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_OBJECT_A	Call by reference	☐	Type reference (TYPE)	SIBFLPORB		Lokale Persistente Objektreferenz - BOR kompatibel	20110506
2	Importing	IS_OBJECT_B	Call by reference	☐	Type reference (TYPE)	SIBFLPORB		Lokale Persistente Objektreferenz - BOR kompatibel	20110506
3	Importing	IV_RELTYPE	Call by reference	☐	Type reference (TYPE)	OBLRELTYPE		Verknüpfungstyp	20110506
4	Returning	RV_LAST_ONE	Value transfer	☐	Type reference (TYPE)	SAP_BOOL		boolsche Variable (X=true, space=false)	20110506

Method DELETE_LINK on class CL_GOS_API_MSG has no exception.

Method GET_ITEM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_ATTKEY	Call by reference	☐	Type reference (TYPE)	GOS_S_ATTKEY		GOS API: Schlüsselstruktur einer Anlage	20110324
2	Returning	RS_ATTCONT	Value transfer	☐	Type reference (TYPE)	GOS_S_ATTCONT		GOS API: Struktur für Anlage	20110308

#	Exception	Resumable	Description	Created on
1	CX_GOS_API	☐	GOS Anlagenliste	20110308

Method GET_OBJ_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_MSG_AL_ITEM	Call by reference	☐	Object reference (TYPE REF TO)	CL_MSG_AL_ITEM			20110308
2	Returning	RV_ID	Value transfer	☐	Type reference (TYPE)	STRING			20110308

#	Exception	Resumable	Description	Created on
1	CX_GOS_API	☐	GOS Anlagenliste	20110308

Method INSERT_ITEM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_ATTCONT	Call by reference	☐	Type reference (TYPE)	GOS_S_ATTCONT		GOS API: Struktur für Anlage	20110322
2	Importing	IS_OBJECT	Call by reference	☐	Type reference (TYPE)	SIBFLPORB		GOS API: Objekt	20110322
3	Importing	IV_ROLTYPE	Call by reference	☐	Type reference (TYPE)	OBLROLTYPE			20110429
4	Returning	RV_COMMIT	Value transfer	☐	Type reference (TYPE)	FLAG		Commit benötigt	20110323

#	Exception	Resumable	Description	Created on
1	CX_GOS_API	☐	GOS Anlagenliste	20110322

Method OBJECT_LOCK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_OBJECT	Call by reference	☐	Type reference (TYPE)	SO_ENTRYID		Objektschlüssel	20110311
2	Returning	RV_LOCK_SET	Value transfer	☐	Type reference (TYPE)	SAP_BOOL		boolsche Variable (X=true, space=false)	20110311

Method OBJECT_LOCK on class CL_GOS_API_MSG has no exception.

Method OBJECT_UNLOCK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_OBJECT	Call by reference	☐	Type reference (TYPE)	SO_ENTRYID		Objektschlüssel	20110311

Method OBJECT_UNLOCK on class CL_GOS_API_MSG has no exception.

Method UPDATE_ITEM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_ATTCONT	Call by reference	☐	Type reference (TYPE)	GOS_S_ATTCONT		GOS API: Struktur der Ausgabetabelle für Anlagenliste	20110317
2	Importing	IS_OBJECT	Call by reference	☐	Type reference (TYPE)	SIBFLPORB		GOS API: Objekt	20110322
3	Returning	RV_COMMIT	Value transfer	☐	Type reference (TYPE)	FLAG		Commit benötigt	20110322

#	Exception	Resumable	Description	Created on
1	CX_GOS_API	☐	GOS Anlagenliste	20110308

History

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