SAP ABAP Class CL_RSOD_DOC_COLLECTION (BW Amount of Documents)

Hierarchy

☛ SAP_BW (Software Component) SAP Business Warehouse
   ⤷ BW-WHM-MTD (Application Component) Metadata (Repository)
     ⤷ RSOD (Package) KW Document Link (Core)

Properties

Class	CL_RSOD_DOC_COLLECTION
Short Description	BW Amount of Documents
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	RSOD	KW Document Link (Core)
Created	20001206	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	RS	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
2	RSSB	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_RSOD_DOC_COLLECTION has no interface implemented.

Friends

Class CL_RSOD_DOC_COLLECTION has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	N_TH_DOC	Instance attribute	Public	☑	Type reference (TYPE)	RSOD_TH_DOC_R		BW DOKUMENTE	20001206
2	N_TS_IO_PROP	Instance attribute	Public	☑	Type reference (TYPE)	RSOD_TS_IO_PROP		Document Properties (Cache)	20010517
3	P_THX_PROP	Instance attribute	Private	☐	Type reference (TYPE)	PT_THX_PROP		not yet used	20020206

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_DOC	Instance method	Public	Method	Add Document	20010517
2	ADD_PROPERTY_TO_CACHE	Instance method	Private	Method	Add a property to the buffer	20010807
3	BUILD_PROPERTIES	Instance method	Private	Method	Structure of the properties table	20010807
4	BUILD_PROPERTY_CACHE	Instance method	Private	Method	Build Properties Cache (Still Empty)	20010517
5	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20001206
6	DELETE_DOCUMENTS	Instance method	Public	Method	Delete document with dialog (also form DB)	20010807
7	GET_IOS_AS_TABLE	Instance method	Public	Method	Delivers Documents as Tables	20001206
8	GET_ITERATOR	Instance method	Public	Method	Gets Iterator for Documents	20020125
9	GET_PROP_VALUE	Instance method	Public	Method	Delivers a Document Property	20010517
10	GET_TRANSPORT_INFO	Instance method	Public	Method	Delivers Transport Entries of Document (LOIO + All PHIOs)	20010613
11	GET_VALUES_FOR_PROPERTY	Instance method	Public	Method	Delivers all Property Values for all Documents	20010517
12	REDUCE_BY_INIT_PROPERTIES	Instance method	Public	Method	Eliminate objects with properties that are not empty	20010517
13	REDUCE_BY_PROP	Static method	Public	Method	Reduce List of Documents with Properties	20020124
14	REDUCE_BY_SINGLE_PROP	Instance method	Public	Method	Reduce Current Documents with a Property	20020829
15	REMOVE_DOC	Instance method	Public	Method	Remove Document	20010517
16	STORE_IN_CLUSTER	Instance method	Public	Method	Store Class in Cluster	20020128

Events

#	Event	Type	Visibility	Description	Created on
1	DOC_REMOVED	Instance Event (0)	Public (2)	Document has been removed	20020208

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	PT_TH_OBJECT	Private	See coding		Documentation Objects Hast Table	20020206

Method Signatures

Method ADD_DOC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_R_DOC	Call by reference	☑	Object reference (TYPE REF TO)	CL_RSOD_DOC		BW Dokument	20010807
2	Importing	I_S_LOIO	Call by reference	☑	Type reference (TYPE)	SKWF_IO		KW Framework: Objektschlüssel	20010807
3	Returning	R_S_DOC_R	Value transfer	☐	Type reference (TYPE)	RSOD_S_DOC_R		BW Dokument mit Referenz	20010613

Method ADD_DOC on class CL_RSOD_DOC_COLLECTION has no exception.

Method ADD_PROPERTY_TO_CACHE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_S_PROP	Call by reference	☐	Type reference (TYPE)	SDOKPROPTY		SDOK: Attribut eines Objektes, Name und Ausprägung	20010807

Method ADD_PROPERTY_TO_CACHE on class CL_RSOD_DOC_COLLECTION has no exception.

Method BUILD_PROPERTIES Signature

Method BUILD_PROPERTIES on class CL_RSOD_DOC_COLLECTION has no parameter.
Method BUILD_PROPERTIES on class CL_RSOD_DOC_COLLECTION has no exception.

Method BUILD_PROPERTY_CACHE Signature

Method BUILD_PROPERTY_CACHE on class CL_RSOD_DOC_COLLECTION has no parameter.
Method BUILD_PROPERTY_CACHE on class CL_RSOD_DOC_COLLECTION has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CLUSTERID	Call by reference	☑	Type reference (TYPE)	SYSUUID_C		UUID in Character-Darstellung	20020128
2	Importing	I_KEEP_CLUSTER	Call by reference	☐	Type reference (TYPE)	RS_BOOL	RS_C_FALSE	='X': Cluster Daten nicht löschen	20030117
3	Importing	I_TH_IO	Call by reference	☑	Type reference (TYPE)	RSOD_TH_IO		Tabelle mit getypten Info Objekten	20010309
4	Importing	I_TH_IO_SEARCH	Call by reference	☑	Type reference (TYPE)	RSOD_TH_IO_SEARCH		BW Dokumente mit Suchergebnissen	20020320
5	Importing	I_TS_IO_PROP	Call by reference	☑	Type reference (TYPE)	RSOD_TS_IO_PROP		Eigenschaften mehrerer Dokumente (sortiert)	20020125
6	Importing	I_T_IO	Call by reference	☑	Type reference (TYPE)	SKWF_IOS		Tabelle mit getypten Info Objekten	20010309
7	Importing	I_T_IO_PROP	Call by reference	☑	Type reference (TYPE)	SDOKPROPTLS		Liste von Attributausprägungen von Objekten	20010517

#	Exception	Resumable	Description	Created on
1	CX_RS_FAILED	☐	Operation gescheitert	20020206

Method DELETE_DOCUMENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_DELETE_ALL	Call by reference	☐	Type reference (TYPE)	RS_BOOL	RS_C_FALSE	= 'X' Alle Dokumente der Collection löschen	20020510
2	Importing	I_DIALOG	Call by reference	☐	Type reference (TYPE)	RS_BOOL	RS_C_TRUE	Aufruf im Dialog	20010808
3	Importing	I_R_TERMINOLOGY	Call by reference	☑	Object reference (TYPE REF TO)	CL_KWUI_TERMINOLOGY		Gui Texte, Icons, Nachrichten, Popups usw.	20010807
4	Importing	I_T_IO	Value transfer	☑	Type reference (TYPE)	SKWF_IOS		Zu Löschende Dokumente	20010807

#	Exception	Resumable	Description	Created on
1	CX_RS_ERROR	☐	BW: Allgemeine Fehlerklasse	20010808

Method GET_IOS_AS_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_T_IO	Value transfer	☐	Type reference (TYPE)	SKWF_IOS		Tabelle mit getypten Info Objekten	20001206

Method GET_IOS_AS_TABLE on class CL_RSOD_DOC_COLLECTION has no exception.

Method GET_ITERATOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_R_DOC_ITERATOR	Value transfer	☐	Object reference (TYPE REF TO)	CL_RSOD_DOC_ITERATOR		Iterator für eine Menge von Dokumenten	20020125

Method GET_ITERATOR on class CL_RSOD_DOC_COLLECTION has no exception.

Method GET_PROP_VALUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_PROP_NAME	Call by reference	☐	Type reference (TYPE)	SDOK_PROPN		Attribut eines Dokuments oder einer Beziehung	20010517
2	Importing	I_R_DOC	Call by reference	☐	Object reference (TYPE REF TO)	CL_RSOD_DOC		Dokument	20010517
3	Returning	R_T_PROP_VALUE	Value transfer	☐	Type reference (TYPE)	SDOKPROPTVS		Attributausprägung(en)	20010517

Method GET_PROP_VALUE on class CL_RSOD_DOC_COLLECTION has no exception.

Method GET_TRANSPORT_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_T_OBJECT	Value transfer	☐	Type reference (TYPE)	TREDT_OBJECTS		Zu bearbeitende Objekte (Korrekturschnittstelle)	20010613

Method GET_TRANSPORT_INFO on class CL_RSOD_DOC_COLLECTION has no exception.

Method GET_VALUES_FOR_PROPERTY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_PROP_NAME	Call by reference	☐	Type reference (TYPE)	SDOK_PROPN		Eigenschaft eines Dokuments oder einer Beziehung	20010517
2	Returning	R_TS_VALUE	Value transfer	☐	Type reference (TYPE)	RSOD_TS_VALUE		Tabelle von Werten von Dokumenteigenschaften	20010517

Method GET_VALUES_FOR_PROPERTY on class CL_RSOD_DOC_COLLECTION has no exception.

Method REDUCE_BY_INIT_PROPERTIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_TS_PROP_FIX	Call by reference	☑	Type reference (TYPE)	RSOD_TS_QUPROP		FIxe Dokumentselektion	20070803
2	Importing	I_T_PROP_INITIAL	Call by reference	☐	Type reference (TYPE)	SDOKPROPTNS		List von Attributnamen (als Struktur)	20010517

Method REDUCE_BY_INIT_PROPERTIES on class CL_RSOD_DOC_COLLECTION has no exception.

Method REDUCE_BY_PROP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_TS_IO_PROP	Call by reference	☐	Type reference (TYPE)	RSOD_TS_IO_PROP		Dokumente mit Eigenschaften	20020124
2	Importing	I_TS_PROP	Call by reference	☐	Type reference (TYPE)	RSOD_TS_PROP		Eigenschaften zum Ausdünnen	20020124
3	Returning	R_TS_IO_PROP_REDUCED	Value transfer	☐	Type reference (TYPE)	RSOD_TS_IO_PROP		ausgedünnte Dokumente mit Eigenschaften	20020124

Method REDUCE_BY_PROP on class CL_RSOD_DOC_COLLECTION has no exception.

Method REDUCE_BY_SINGLE_PROP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_NAME	Call by reference	☐	Type reference (TYPE)	SDOK_PROPN		Attribut eines Dokuments oder einer Beziehung	20020829
2	Importing	I_T_RANGE	Call by reference	☐	Type reference (TYPE)	RSOD_T_RANGE		Range Tabelle für Dokumentattributwerte	20020829

Method REDUCE_BY_SINGLE_PROP on class CL_RSOD_DOC_COLLECTION has no exception.

Method REMOVE_DOC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_PROP_FROM	Call by reference	☑	Type reference (TYPE)	I		Startindex der Eigenschaften (falls bekannt)	20020123
2	Importing	I_PROP_TO	Call by reference	☑	Type reference (TYPE)	I		Endindex der Eigenschaften (falls bekannt)	20020123
3	Importing	I_S_OBJECT	Call by reference	☐	Type reference (TYPE)	SDOKOBJECT		SDOK: BOR-Schlüssel für Informationsobjekt	20010517

Method REMOVE_DOC on class CL_RSOD_DOC_COLLECTION has no exception.

Method STORE_IN_CLUSTER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CLUSTERID	Call by reference	☐	Type reference (TYPE)	SYSUUID_C		UUID in Character-Darstellung	20020128

Method STORE_IN_CLUSTER on class CL_RSOD_DOC_COLLECTION has no exception.

Event Signatures

Event DOC_REMOVED Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	I_PROP_FROM	Exporting	Value transfer	☐	Type reference (TYPE)	I		Von Index	20020208
2	I_PROP_TO	Exporting	Value transfer	☐	Type reference (TYPE)	I		Bis index	20020208

History

Last changed by/on	SAP	20130531
SAP Release Created in	30A