SAP ABAP Class CL_KW_DOCUMENTS (Documents Collection)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-KPR-DMF (Application Component) Document Management Framework
     ⤷ SKWV (Package) Knowledge Warehouse: Visual Components

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_KW_AUTOMATION_OBJECT_USE	For Internal Use	20000316

Properties

Class	CL_KW_DOCUMENTS
Short Description	Documents Collection
Super Class	CL_KW_AUTOMATION_OBJECT_USE	For Internal Use
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	SKWV	Knowledge Warehouse: Visual Components
Created	19991220	SAP
Last change	20000620	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_KW_DOCUMENTS has no forward declaration.

Interfaces

Class CL_KW_DOCUMENTS has no interface implemented.

Friends

Class CL_KW_DOCUMENTS has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	DOCUMENTS	Instance attribute	Private	☐	Type reference (TYPE)	SKWV_DOC_T		Internal References to Documents	19991220
2	PARENT	Instance attribute	Private	☐	Object reference (TYPE REF TO)	OBJECT		Internal Reference to Superior Object	19991220

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD	Instance method	Public	Method	Create new document	19991220
2	INSERT	Instance method	Public	Method	@0A@Internal - DO NOT USE!	20000222
3	ITEM	Instance method	Public	Method	Access to a Single Document	19991220
4	OPEN	Instance method	Public	Method	Open a Document	19991220
5	REMOVE	Instance method	Public	Method	@0A@Internal - DO NOT USE!	19991220

Events

Class CL_KW_DOCUMENTS has no event.

Types

Class CL_KW_DOCUMENTS has no local type.

Method Signatures

Method ADD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	COPYTEMPLATEFILENAME	Call by reference	☑	Type reference (TYPE)	C		char255	19991220
2	Importing	MIMETYPE	Call by reference	☐	Type reference (TYPE)	SKWF_MIME			19991220
3	Exporting	NEW_DOCUMENT	Call by reference	☐	Object reference (TYPE REF TO)	CL_KW_DOCUMENT		Referenz auf neues Dokument	19991220
4	Importing	OPENMODE	Call by reference	☑	Type reference (TYPE)	I		spezielle Öffnungsattribute	19991220

#	Exception	Resumable	Description	Created on
1	CREATION_FAILED	☐	Neuanlegen eines Dokumentes ist fehlgeschlagen	19991220

Method INSERT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOCUMENT	Call by reference	☐	Object reference (TYPE REF TO)	CL_KW_DOCUMENT		Dokumentklasse	20000222

#	Exception	Resumable	Description	Created on
1	INSERT_FAILED	☐	insert_failed	20000222

Method ITEM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	DOCUMENT	Call by reference	☐	Object reference (TYPE REF TO)	CL_KW_DOCUMENT		Dokumentklasse	19991220
2	Importing	FILENAME	Call by reference	☑	Type reference (TYPE)	C		Zugriff über Dateinamen	19991220
3	Importing	INDEX	Call by reference	☑	Type reference (TYPE)	I		Zugriff über Index	19991220

#	Exception	Resumable	Description	Created on
1	DOCUMENT_NOT_AVAILABLE	☐	Dokument nicht vorhanden	19991220
2	ILLEGAL_INDEX	☐	Zugriff entweder über Index oder über Dateinamen	19991220

Method OPEN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FILENAME	Call by reference	☐	Type reference (TYPE)	C		char255	19991220
2	Exporting	OPENED_DOCUMENT	Call by reference	☐	Object reference (TYPE REF TO)	CL_KW_DOCUMENT		Referenz auf geöffnetes Dokument	19991220
3	Importing	OPENMODE	Call by reference	☑	Type reference (TYPE)	I		Spezielle Anzeigeattribute	19991220

#	Exception	Resumable	Description	Created on
1	OPEN_FAILED	☐	Öffnen des Dokuments ist fehlgeschlagen	19991220

Method REMOVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FILENAME	Call by reference	☑	Type reference (TYPE)	C		Entfernen über Dateinamen	19991220
2	Importing	INDEX	Call by reference	☑	Type reference (TYPE)	I		Entfernen über Index	19991220

#	Exception	Resumable	Description	Created on
1	REMOVE_FAILED	☐	Fehler beim Entfernen	19991220

History

Last changed by/on	SAP	20000620
SAP Release Created in	46C