SAP ABAP Class CL_QM_DOCUMENT_DATA_MNGR (QM OData: Documents Data Manager)

Hierarchy

☛ EA-APPL (Software Component) SAP Enterprise Extension PLM, SCM, Financials
   ⤷ QM (Application Component) Quality Management
     ⤷ ODATA_QM_NOTIFICATION (Package) OData Services for Notification

Properties

Class	CL_QM_DOCUMENT_DATA_MNGR
Short Description	QM OData: Documents Data Manager
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	ODATA_QM_NOTIFICATION	OData Services for Notification
Created	20131113	SAP
Last change	20140121	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

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

Interfaces

Class CL_QM_DOCUMENT_DATA_MNGR has no interface implemented.

Friends

Class CL_QM_DOCUMENT_DATA_MNGR has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MC_LOGICAL_FILENAME	Constant	Public	☐	Type reference (TYPE)	FILEINTERN	'QOD_IMAGE'	Logical file name	20131113
2	MC_MAX_FILE_SIZE	Constant	Public	☐	Type reference (TYPE)	I	100000	Maximum upload file size in bytes	20131113
3	MC_OBJECT_TYPE	Constant	Public	☐	Type reference (TYPE)	DOKOB	'QMQMEL'	Linked SAP Object	20131113

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CREATE_TMP_FILE	Static method	Public	Method	Create temporary file	20131113
2	GET_DOCUMENT_STREAM	Static method	Public	Method	Get QM document stream	20131113
3	GET_DOC_TYPES	Static method	Public	Method	Get Alloed Document Types	20131113
4	GET_FILES_PROPERTIES	Static method	Public	Method		20131211
5	GET_FILE_STREAM	Static method	Public	Method	Get byte stream of file	20131113
6	READ_NOTIF_DOC_COUNT	Static method	Public	Method	Get notification number of documents table	20131113
7	REMOVE_TMP_FILE	Static method	Public	Method	Delte temporary file	20131113

Events

Class CL_QM_DOCUMENT_DATA_MNGR has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	T_DOC_EXT_S	Public	See coding			20131113	BEGIN OF t_doc_ext_s, dappl TYPE dappl, dateifrmt TYPE dateifrmt, END OF t_doc_ext_s
2	T_DOC_EXT_T	Public	See coding			20131113	t_doc_ext_t TYPE STANDARD TABLE OF t_doc_ext_s

Method Signatures

Method CREATE_TMP_FILE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_RETURN	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20131113
2	Importing	IS_ATT_CONFIG	Call by reference	☐	Type reference (TYPE)	QOD_ATT_CONFIG		Attachment Configuration	20131113
3	Importing	IV_DATA	Call by reference	☐	Type reference (TYPE)	STRING			20131113
4	Importing	IV_NOTIFICATION_ID	Call by reference	☐	Type reference (TYPE)	QMNUM		Notification No	20131113
5	Returning	RV_FILENAME	Value transfer	☐	Type reference (TYPE)	STRING			20131113

Method CREATE_TMP_FILE on class CL_QM_DOCUMENT_DATA_MNGR has no exception.

Method GET_DOCUMENT_STREAM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_DOCUMENT_STREAM	Call by reference	☐	Type reference (TYPE)	/IWBEP/CL_MGW_ABS_DATA=>TY_S_MEDIA_RESOURCE		Media Type Information	20131113
2	Exporting	ET_RETURN	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20131113
3	Exporting	EV_FILE_NAME	Call by reference	☐	Type reference (TYPE)	DKTXT		Document description	20131113
4	Importing	IV_DOCUMENT_NUMBER	Call by reference	☐	Type reference (TYPE)	DOKNR		Document number	20131113
5	Importing	IV_NOTIFICATION	Call by reference	☐	Type reference (TYPE)	QMNUM		Notification No	20131113

Method GET_DOCUMENT_STREAM on class CL_QM_DOCUMENT_DATA_MNGR has no exception.

Method GET_DOC_TYPES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_ALLOWED_DOC_TYPES	Call by reference	☐	Type reference (TYPE)	QOD_DOCTYPE_T		QM Statuses Customizing	20131113
2	Exporting	ET_RETURN	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20131113
3	Importing	IT_FILTER_SELECT_OPTIONS	Call by reference	☑	Type reference (TYPE)	/IWBEP/T_MGW_SELECT_OPTION		table of select options	20131113
4	Importing	IV_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	DOKOB		Linked SAP Object	20131115
5	Importing	IV_SRCH_TYPES	Call by reference	☐	Type reference (TYPE)	CHAR20		Char 20	20131113

Method GET_DOC_TYPES on class CL_QM_DOCUMENT_DATA_MNGR has no exception.

Method GET_FILES_PROPERTIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_DMS_OBJECTS	Call by reference	☐	Type reference (TYPE)	DMS_TBL_OBJECTLINKS		Table Type for Object Link Search	20131211
2	Exporting	ET_DMS_OBJECTS_LINKS	Call by reference	☐	Type reference (TYPE)	IF_QM_NOTIF_CONSTANTS=>TY_T_OBJECTS_LINKS		Table Type for bapi_doc_drad_keys	20131211
3	Exporting	ET_DOCUMENTS_DESCRIPTIONS	Call by reference	☐	Type reference (TYPE)	IF_QM_NOTIF_CONSTANTS=>TY_T_DOCUMENTS_DESCRIPTIONS			20131211
4	Exporting	ET_DOCUMENTS_FILES	Call by reference	☐	Type reference (TYPE)	IF_QM_NOTIF_CONSTANTS=>TY_T_DOCUMENTS_FILES			20131211
5	Exporting	ET_FILES_PROPERTIES	Call by reference	☐	Type reference (TYPE)	IF_QM_NOTIF_CONSTANTS=>TY_T_FILES_PROPERTIES		SDOK: Table for Component Attributes with Document ID	20131211

Method GET_FILES_PROPERTIES on class CL_QM_DOCUMENT_DATA_MNGR has no exception.

Method GET_FILE_STREAM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_RETURN	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20131113
2	Exporting	EV_MIME_TYPE	Call by reference	☐	Type reference (TYPE)	W3CONTTYPE		HTML content type	20131211
3	Exporting	EV_STREAM	Call by reference	☐	Type reference (TYPE)	XSTRING			20131113
4	Importing	IV_DOCUMENT_NUMBER	Call by reference	☐	Type reference (TYPE)	DOKNR		Document number	20131113
5	Importing	IV_DOCUMENT_PART	Call by reference	☐	Type reference (TYPE)	DOKTL_D		Document part	20131113
6	Importing	IV_DOCUMENT_TYPE	Call by reference	☐	Type reference (TYPE)	DOKAR		Document Type	20131113
7	Importing	IV_DOCUMENT_VERSION	Call by reference	☐	Type reference (TYPE)	DOKVR		Document version	20131113

Method GET_FILE_STREAM on class CL_QM_DOCUMENT_DATA_MNGR has no exception.

Method READ_NOTIF_DOC_COUNT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_OBJ_KEYS	Call by reference	☐	Type reference (TYPE)	QOD_OBJ_KEYS		Table of object keys	20131113
2	Returning	RT_RESULT	Value transfer	☐	Type reference (TYPE)	QOD_ATTACHMENT_COUNT_T		Attachments count table	20131113

Method READ_NOTIF_DOC_COUNT on class CL_QM_DOCUMENT_DATA_MNGR has no exception.

Method REMOVE_TMP_FILE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_RETURN	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB			20131127
2	Importing	IV_NOTIFICATION_ID	Call by reference	☐	Type reference (TYPE)	QMNUM		Notification No	20131113

Method REMOVE_TMP_FILE on class CL_QM_DOCUMENT_DATA_MNGR has no exception.

History

Last changed by/on	SAP	20140121
SAP Release Created in	617