SAP ABAP Class CL_SA_IO_DOC (Solution Manager Document in KW)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ SV-SMG-IMP (Application Component) Solution Manager Implementation
     ⤷ SOLAR_DOC (Package) Document Management in Solution Manager

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_SA_IO	SAP Solution Manager: Info Object in Knowledge Warehouse	20010216

Properties

Class	CL_SA_IO_DOC
Short Description	Solution Manager Document in KW
Super Class	CL_SA_IO	SAP Solution Manager: Info Object in Knowledge Warehouse
Instantiability of a Class	1	Protected
Final	☑

General Data

Message Class
Program status
Category	0
Package	SOLAR_DOC	Document Management in Solution Manager
Created	20010216	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_SA_IO_DOC has no forward declaration.

Interfaces

Class CL_SA_IO_DOC has no interface implemented.

Friends

#	Friend	Modeled only	Created on	Description
1	CL_SA_DOC_FACTORY	☐	20010314	SAP Solution Manager: Document Management

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	AT_STATUSTRIGGER	Instance attribute	Protected	☐	Type reference (TYPE)	SADOCSTATUSTRIGGER_T		Actions triggered by the status	20050418
2	A_CURRENT_PROJECT	Instance attribute	Private	☐	Type reference (TYPE)	PROJECT_ID		Current Project	20060526
3	A_CURRENT_SOLUTION	Instance attribute	Private	☐	Type reference (TYPE)	SADOCATTRSOLUTION		Current Solution	20100223
4	A_DOC_TYPE	Instance attribute	Private	☐	Type reference (TYPE)	IWIOPROPS-TYPE		Document Type	20010216
5	A_ITAB_REF_DOCU	Instance attribute	Private	☐	Type reference (TYPE)	SADOCLOIOTITLE_T		Document Title	20040420
6	A_IWB_TYPE	Instance attribute	Private	☐	Type reference (TYPE)	IWIOPROPS-TYPE		Content type	20011114
7	A_SKIP_SIGNATURE	Instance attribute	Protected	☐	Type reference (TYPE)	FLAG		No signature	20050418
8	C_IO_ATTR_DOC_PROTECTION	Instance attribute	Protected	☐	Attribute reference (LIKE)				20050308
9	C_IO_ATTR_IWB_CLASSIFICATION	Instance attribute	Protected	☐	Attribute reference (LIKE)				20050308
10	C_IO_ATTR_IWB_SOLAR_ORIG_ID	Instance attribute	Protected	☐	Attribute reference (LIKE)				20050308
11	C_IO_ATTR_STORAGE_CATEGORY_URL	Instance attribute	Protected	☐	Attribute reference (LIKE)				20050308
12	LT_INIT_ATT_SIMPLE	Instance attribute	Private	☐	Type reference (TYPE)	SADOCATTRCHANGED		Display Structure for Changing Document Attribute	20040421
13	LT_NEW_ATT_SIMPLE	Instance attribute	Private	☐	Type reference (TYPE)	SADOCATTRCHANGED		Display Structure for Changing Document Attribute	20040420
14	R_PHIO	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_SA_DOC_CONT		Reference to Physical Info Object	20010308

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_TO_NEW_PROPERTIES	Instance method	Protected	Method	Determines New Attribute Value	20060526
2	BUILD_AND_SET_INIT_ATT_TABLES	Instance method	Private	Method		20040421
3	BUILD_AND_SET_NEW_ATT_TABLES	Instance method	Private	Method		20040420
4	CHECK_IWB_TYPE	Instance method	Protected	Method	Checks If Value Exists	20011127
5	CLEAR_STATUSTRIGGER	Instance method	Public	Method	Resets at_statustrigger	20120131
6	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20010216
7	COPY_IO	Instance method	Protected	Method	Copies Info Object from Knowledge Warehouse	20010403
8	DEQUEUE_PHIO	Instance method	Protected	Method	Unlock a Document via PHIO	20030710
9	ENQUEUE_PHIO	Instance method	Protected	Method	Lock a Document Directly via PHIO	20030710
10	GET_DOC_TYPE	Instance method	Public	Method	Reads Doc. Type before Change	20120131
11	GET_PROPS_TO_SAVE	Instance method	Private	Method	Provides Attributes to be Saved	20010330
12	GET_REF_TO_DELETE	Instance method	Private	Method		20040316
13	GET_REF_TO_INSERT	Instance method	Private	Method		20040316
14	GET_VERSIONS	Instance method	Public	Method	Gets all Released Versions	20030509
15	HANDLE_EXIT_BEFORE_DELETE	Instance method	Protected	Method	Call BADI at 'Before Deletion'	20100223
16	HANDLE_EXIT_BEFORE_SAVE	Instance method	Protected	Method	Call BADI at Event 'Before Save'	20060526
17	HANDLE_SIGNATURE	Instance method	Public	Method	Start Signature	20050308
18	HANDLE_STATUS_LOCK	Instance method	Protected	Method	Checks and Sets Status Lock, if Required	20050308
19	HANDLE_STATUS_TRIGGER	Instance method	Protected	Method	Determine and Perform Status Actions	20050308
20	SKIP_SIGNATURE	Instance method	Public	Method	Do Not Sign	20050418
21	UPLOAD_IO	Instance method	Protected	Method	Creates New Info Object from File System	20010403

Events

Class CL_SA_IO_DOC has no event.

Types

Class CL_SA_IO_DOC has no local type.

Method Signatures

Method ADD_TO_NEW_PROPERTIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_NEW_PROPERTIES	Call by reference	☐	Type reference (TYPE)	SDOKPROPTYS		SDOK: Liste von Name-Wert-Paaren	20060526
2	Importing	I_PROPERTY	Call by reference	☐	Type reference (TYPE)	SDOKPROPTY		SDOK: Attribut eines Objektes, Name und Ausprägung	20060526

Method ADD_TO_NEW_PROPERTIES on class CL_SA_IO_DOC has no exception.

Method BUILD_AND_SET_INIT_ATT_TABLES Signature

Method BUILD_AND_SET_INIT_ATT_TABLES on class CL_SA_IO_DOC has no parameter.
Method BUILD_AND_SET_INIT_ATT_TABLES on class CL_SA_IO_DOC has no exception.

Method BUILD_AND_SET_NEW_ATT_TABLES Signature

Method BUILD_AND_SET_NEW_ATT_TABLES on class CL_SA_IO_DOC has no parameter.
Method BUILD_AND_SET_NEW_ATT_TABLES on class CL_SA_IO_DOC has no exception.

Method CHECK_IWB_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IWB_TYPE	Call by reference	☐	Type reference (TYPE)	IWIOPROPS-TYPE		Content type	20011127

#	Exception	Resumable	Description	Created on
1	DOES_NOT_EXIST	☐		20011127

Method CLEAR_STATUSTRIGGER Signature

Method CLEAR_STATUSTRIGGER on class CL_SA_IO_DOC has no parameter.
Method CLEAR_STATUSTRIGGER on class CL_SA_IO_DOC has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_PHYSICAL_OBJECT	Call by reference	☑	Type reference (TYPE)	SDOKOBJECT		explizit gewünschte PHIO	20030509
2	Importing	IT_BIREFERENCE_DOCU	Call by reference	☑	Type reference (TYPE)	SADOCLOIOTITLE_T			20060724
3	Importing	IT_CONTEXT	Call by reference	☑	Type reference (TYPE)	SDOKPROPTYS		Context	20010216
4	Importing	IT_IO_ATTR	Call by reference	☑	Type reference (TYPE)	SASDOKATTRIB_T		Overrides Display in Attribute Maintenance	20010319
5	Importing	IT_PROPERTIES	Call by reference	☑	Type reference (TYPE)	SDOKPROPTYS		Initiale Dokumentenattribute	20040106
6	Importing	IT_REFERENCE_DOCU	Call by reference	☑	Type reference (TYPE)	SDOKRELISTS			20040316
7	Importing	I_AREA	Call by reference	☑	Type reference (TYPE)	IWBAREA-AREA		Area	20010216
8	Importing	I_AS_COPY	Call by reference	☐	Type reference (TYPE)	CHAR1	SPACE	Creating info object as copy	20010330
9	Importing	I_CLASS	Call by reference	☐	Type reference (TYPE)	SDOKOBJECT-CLASS		Document Class	20010216
10	Importing	I_DOCUMENT_ID	Call by reference	☑	Type reference (TYPE)	SDOKOBJECT-OBJID		ID for documents and relations	20010216
11	Importing	I_DOC_FOLDER	Call by reference	☑	Object reference (TYPE REF TO)	IF_SA_IO		Interface for KW Info Object Attributes	20010216
12	Importing	I_DOC_STRUCTURE	Call by reference	☑	Object reference (TYPE REF TO)	IF_SA_IO		Info Object Structure	20010410
13	Importing	I_FORMAT	Call by reference	☑	Type reference (TYPE)	CHAR10		File Format (Required Entry if No Template Exists)	20010308
14	Importing	I_HANDLE_AS_TEMPLATE	Call by reference	☑	Type reference (TYPE)	FLAG		Das übergeben Dokument wird als Kopiervorlage benutzt	20061113
15	Importing	I_NEW_IO	Call by reference	☐	Type reference (TYPE)	CHAR1	SPACE	Create info object again	20010311
16	Importing	I_NO_ENQUEUE	Call by reference	☐	Type reference (TYPE)	CHAR1	SPACE	Einstelliges Kennzeichen	20050504
17	Importing	I_READONLY	Call by reference	☐	Type reference (TYPE)	CHAR1	SPACE	No changes allowed	20010306
18	Importing	I_TECH_NAME	Call by reference	☑	Type reference (TYPE)	IWIOPROPS-TECH_NAME		Technical name of an information object	20010216
19	Importing	I_TITLE	Call by reference	☑	Type reference (TYPE)	IWIOPROPS-TITLE		Title	20010216
20	Importing	I_TYPE	Call by reference	☑	Type reference (TYPE)	IWIOPROPS-TYPE		Documentation type	20010216
21	Importing	I_UNLOCK	Call by reference	☐	Type reference (TYPE)	FLAG	SPACE		20080124

#	Exception	Resumable	Description	Created on
1	ERROR	☐	General Error	20010216
2	FOREIGN_LOCK	☐	Document is locked	20010313
3	NOT_FOUND	☐	Document not found	20010311

Method COPY_IO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_SRC_LOIO	Call by reference	☐	Type reference (TYPE)	SDOKOBJECT		SDOK: BOR key for information object	20010403

#	Exception	Resumable	Description	Created on
1	ERROR	☐	General Error	20010403
2	READ_ONLY	☐	No changes allowed	20010403

Method DEQUEUE_PHIO Signature

Method DEQUEUE_PHIO on class CL_SA_IO_DOC has no parameter.

#	Exception	Resumable	Description	Created on
1	ERROR	☐		20030710

Method ENQUEUE_PHIO Signature

Method ENQUEUE_PHIO on class CL_SA_IO_DOC has no parameter.

#	Exception	Resumable	Description	Created on
1	ERROR	☐		20030710

Method GET_DOC_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_DOC_TYPE	Value transfer	☐	Type reference (TYPE)	IW_IO_TYPE		Inhaltstyp	20120131

Method GET_DOC_TYPE on class CL_SA_IO_DOC has no exception.

Method GET_PROPS_TO_SAVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ET_PROPERTIES	Value transfer	☐	Type reference (TYPE)	SDOKPROPTYS		SDOK: List of Pairs of Name and Value	20010330

Method GET_PROPS_TO_SAVE on class CL_SA_IO_DOC has no exception.

Method GET_REF_TO_DELETE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ET_REFERENCE_DOCU	Value transfer	☐	Type reference (TYPE)	SDOKRELISTS			20040316

Method GET_REF_TO_DELETE on class CL_SA_IO_DOC has no exception.

Method GET_REF_TO_INSERT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ET_REFERENCE_DOCU	Value transfer	☐	Type reference (TYPE)	SDOKRELISTS			20040316

Method GET_REF_TO_INSERT on class CL_SA_IO_DOC has no exception.

Method GET_VERSIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_VERSIONS	Call by reference	☐	Type reference (TYPE)	SDOKOBJECTS		Liste der freigegebenen Versionen	20030509
2	Exporting	ET_VERSION_PROPERTIES	Call by reference	☐	Type reference (TYPE)	SDOKPROPTLS		Liste von Attributausprägungen von Versionen	20030509
3	Importing	IV_READ_FROM_BUFFER	Call by reference	☐	Type reference (TYPE)	FLAG	'X'	Puffer benutzen - bessere Performance	20030509

Method GET_VERSIONS on class CL_SA_IO_DOC has no exception.

Method HANDLE_EXIT_BEFORE_DELETE Signature

Method HANDLE_EXIT_BEFORE_DELETE on class CL_SA_IO_DOC has no parameter.

#	Exception	Resumable	Description	Created on
1	CANCEL_DELETION	☐		20100223

Method HANDLE_EXIT_BEFORE_SAVE Signature

Method HANDLE_EXIT_BEFORE_SAVE on class CL_SA_IO_DOC has no parameter.

#	Exception	Resumable	Description	Created on
1	CANCEL_SAVING	☐		20060526

Method HANDLE_SIGNATURE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	GENERATE_NEW_PHIO	Call by reference	☑	Type reference (TYPE)	FLAG		Neu Phio ID erzeugen	20050418
2	Importing	PREVIOUS_STATUS	Call by reference	☑	Type reference (TYPE)	SDOKPROPTY-VALUE		Attributausprägung	20060928
3	Importing	STATUS	Call by reference	☑	Type reference (TYPE)	SDOKPROPTY-VALUE		Status des Dokuments	20050418

#	Exception	Resumable	Description	Created on
1	ERROR_GENERATING_ID	☐		20050418
2	SIGNATURE_CANCELLED	☐		20050418
3	SIGNATURE_ERROR	☐		20050418

Method HANDLE_STATUS_LOCK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	STATUS	Call by reference	☐	Type reference (TYPE)	SDOKPROPTY-VALUE		Attributausprägung	20050418

Method HANDLE_STATUS_LOCK on class CL_SA_IO_DOC has no exception.

Method HANDLE_STATUS_TRIGGER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NO_SIGNATURE	Call by reference	☑	Type reference (TYPE)	FLAG		allgemeines flag	20050418

Method HANDLE_STATUS_TRIGGER on class CL_SA_IO_DOC has no exception.

Method SKIP_SIGNATURE Signature

Method SKIP_SIGNATURE on class CL_SA_IO_DOC has no parameter.
Method SKIP_SIGNATURE on class CL_SA_IO_DOC has no exception.

Method UPLOAD_IO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_SRC_PATH	Call by reference	☐	Type reference (TYPE)	STRING		File in File System	20010403

#	Exception	Resumable	Description	Created on
1	ERROR	☐	General Error	20010403
2	READ_ONLY	☐	No changes allowed	20010403

History

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