SAP ABAP Class CL_COCF_KPRO_API (KPro Interface)

Hierarchy

☛ EA-APPL (Software Component) SAP Enterprise Extension PLM, SCM, Financials
   ⤷ PP-SFC (Application Component) Production Orders
     ⤷ COCF (Package) Order and Confirmation Data

Properties

Class	CL_COCF_KPRO_API
Short Description	KPro Interface
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	COCF	Order and Confirmation Data
Created	20061110	SAP
Last change	20100310	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_COCF_KPRO_API has no forward declaration.

Interfaces

Class CL_COCF_KPRO_API has no interface implemented.

Friends

Class CL_COCF_KPRO_API has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CON_X	Constant	Private	☐	Type reference (TYPE)	C	'X'		20061110
2	GT_MAPPING	Instance attribute	Public	☐	Type reference (TYPE)	COCF_T_KPRO_MAPPING		Relationships Between Metadata Fields and KPro Attributes	20061110
3	G_DOCUSPACE	Instance attribute	Private	☐	Type reference (TYPE)	SDOK_DOCSP		Document Area	20061117
4	G_PHIO	Instance attribute	Private	☐	Type reference (TYPE)	SDOK_PHCL		Physical document class	20061110

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHANGE_DOCUMENT	Instance method	Public	Method	Change Document in KPro	20061110
2	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20061110
3	CONV_META_TO_PROP	Instance method	Private	Method	Convert Metadata to Properties	20061110
4	CONV_PROP_TO_META	Instance method	Private	Method	Convert Properties to Metadata	20061110
5	CREATE_DOCUMENT	Instance method	Public	Method	Create Document in KPro	20061110
6	GET_DOCUMENT	Instance method	Public	Method	Get Document Content and Maybe Metadata in KPro	20061110
7	GET_INSTANCE	Static method	Public	Method	Generates a KPro-API Object	20061110
8	SEARCH_DOCUMENT	Instance method	Public	Method	Full Text and Attribute Search in KPro	20061116

Events

Class CL_COCF_KPRO_API has no event.

Types

Class CL_COCF_KPRO_API has no local type.

Method Signatures

Method CHANGE_DOCUMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_DOCUMENT_OBJECT	Call by reference	☐	Type reference (TYPE)	SDOKOBJECT		SDOK: BOR-Schlüssel für Informationsobjekt	20061110
2	Importing	IS_META	Call by reference	☐	Type reference (TYPE)	ANY		Metadaten	20061110

#	Exception	Resumable	Description	Created on
1	ERROR	☐	Fehler (siehe SY-MSG*)	20061110

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_MAPPING	Call by reference	☐	Type reference (TYPE)	COCF_T_KPRO_MAPPING		Beziehungen zwischen Metadatenfeldern und KPro-Attributen	20061110
2	Importing	I_DOCUSPACE	Call by reference	☐	Type reference (TYPE)	SDOK_DOCSP		Dokumentbereich	20061117
3	Importing	I_PHIO	Call by reference	☐	Type reference (TYPE)	SDOK_PHCL		Klasse des physischen Dokuments	20061110

Method CONSTRUCTOR on class CL_COCF_KPRO_API has no exception.

Method CONV_META_TO_PROP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_PROPERTIES	Call by reference	☐	Type reference (TYPE)	SDOKPROPTYS		SDOK: Liste von Name-Wert-Paaren	20061110
2	Importing	IS_META	Call by reference	☐	Type reference (TYPE)	ANY		Metadaten	20061110

Method CONV_META_TO_PROP on class CL_COCF_KPRO_API has no exception.

Method CONV_PROP_TO_META Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_META	Call by reference	☐	Type reference (TYPE)	ANY		Metadaten	20061110
2	Importing	IT_PROPERTIES	Call by reference	☐	Type reference (TYPE)	SDOKPROPTYS		SDOK: Liste von Name-Wert-Paaren	20061110

Method CONV_PROP_TO_META on class CL_COCF_KPRO_API has no exception.

Method CREATE_DOCUMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_META	Call by reference	☐	Type reference (TYPE)	ANY		Metadaten	20061110
2	Importing	I_CONTENT	Call by reference	☐	Type reference (TYPE)	XSTRING		Inhalt des Dokuments	20061110
3	Importing	I_FILENAME	Call by reference	☐	Type reference (TYPE)	SDOK_FILNM		Relativer Ablageort eines physischen Dokuments	20061110
4	Importing	I_MIME_TYPE	Call by reference	☐	Type reference (TYPE)	STRING		MIME-Type des Dokuments	20061110
5	Returning	RS_DOCUMENT_OBJECT	Value transfer	☐	Type reference (TYPE)	SDOKOBJECT		SDOK: BOR-Schlüssel für Informationsobjekt	20061110

#	Exception	Resumable	Description	Created on
1	ERROR	☐	Fehler (siehe SY-MSG*)	20061110

Method GET_DOCUMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_META	Call by reference	☐	Type reference (TYPE)	ANY		Metadaten	20061110
2	Exporting	E_CONTENT	Call by reference	☐	Type reference (TYPE)	XSTRING		Inhalt des Dokuments	20061110
3	Importing	IS_DOCUMENT_OBJECT	Call by reference	☐	Type reference (TYPE)	SDOKOBJECT		SDOK: BOR-Schlüssel für Informationsobjekt	20061110

#	Exception	Resumable	Description	Created on
1	ERROR	☐	Fehler (siehe SY-MSG*)	20061110

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_MAPPING	Call by reference	☐	Type reference (TYPE)	COCF_T_KPRO_MAPPING		Beziehungen zwischen Metadatenfeldern und KPro-Attributen	20061110
2	Importing	I_DOCUSPACE	Call by reference	☐	Type reference (TYPE)	SDOK_DOCSP		Dokumentbereich	20061117
3	Importing	I_PHIO	Call by reference	☐	Type reference (TYPE)	SDOK_PHCL		Klasse des physischen Dokuments	20061110
4	Returning	RO_KPRO_API	Value transfer	☐	Object reference (TYPE REF TO)	CL_COCF_KPRO_API		KPro Interface	20061110

Method GET_INSTANCE on class CL_COCF_KPRO_API has no exception.

Method SEARCH_DOCUMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_DOCUMENTS	Call by reference	☐	Type reference (TYPE)	COCF_T_SEARCH_RESULT		Dokumententrefferliste der Index-Suche	20061116
2	Exporting	E_INCOMPLETE	Call by reference	☐	Type reference (TYPE)	XFELD		Zu viele Treffer bei Dokumentensuche	20061117
3	Importing	IT_PROPERTIES	Call by reference	☑	Type reference (TYPE)	SDOKQUPROPS		Metadaten	20061116
4	Importing	I_KEYWORDS	Call by reference	☑	Type reference (TYPE)	COCF_SEARCH_KEYWORDS		Stichworte für Volltextsuche	20061116
5	Importing	I_LANGUAGE	Call by reference	☑	Type reference (TYPE)	SPRAS		Sprachenschlüssel	20061117
6	Importing	I_SEARCH_TYPE	Call by reference	☐	Type reference (TYPE)	SDOK_TRMAC	'F'	Art der Suchanforderung	20061121

#	Exception	Resumable	Description	Created on
1	ERROR	☐	Fehler (siehe SY-MSG*)	20061116

History

Last changed by/on	SAP	20100310
SAP Release Created in	700