SAP ABAP Class CL_SSC_DOCMNT_SEARCH_DISPATCH (Dispatch Class for CRM's Document Retrieval)

Hierarchy

☛ SAP_BS_FND (Software Component) SAP Business Suite Foundation
   ⤷ CA-EPT-SSC (Application Component) Shared Service Center Framework
     ⤷ BS_SSC_DOCSEARCH (Package) Shared Services - Framework for Document Retrieval

Properties

Class	CL_SSC_DOCMNT_SEARCH_DISPATCH
Short Description	Dispatch Class for CRM's Document Retrieval
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	BS_SSC_DOCSEARCH	Shared Services - Framework for Document Retrieval
Created	20081231	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	ABAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_SSC_DOCMNT_SEARCH_DISPATCH has no interface implemented.

Friends

Class CL_SSC_DOCMNT_SEARCH_DISPATCH has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MD_APPURL	Static Attribute	Private	☐	Type reference (TYPE)	STRING		SSC: URL for ArchiveLink, Application Server Part.	20090430
2	MD_METHODNAME	Instance attribute	Private	☐	Type reference (TYPE)	STRING	'IF_SSC_DOCMNT_COLLECTOR~COLLECT_DOCMNT_DATA'	Collect method name	20090114
3	MT_DOCTYPE	Instance attribute	Private	☐	Type reference (TYPE)	SSC_T_DOCTYPE		Table of Document Type	20090105
4	MT_QUERY_PARAM	Instance attribute	Private	☐	Type reference (TYPE)	SSC_T_QUERY_NAME_VALUE		Name and value pair for query	20090129

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_MESSAGE	Static method	Public	Method	Add Message in format of BAPIRET2	20090224
2	COLLECT_DOCMNT_DATA	Instance method	Public	Method		20081231
3	CONSTRUCTOR	Instance method	Public	Constructor		20081231
4	CONVERT_PARAM_TO_STRUC	Static method	Public	Method	Convert the parameter from front-end	20090312
5	GET_ARCHIVE_INFO	Static method	Public	Method	Get the archived document's URL links	20090224
6	GET_COLLECTOR_CLASS	Instance method	Private	Method		20081231
7	GET_MIMETYPE_BY_DOCTYPE	Static method	Public	Method	Get mimetype by document type defined in TOAVE	20090410
8	SEARCH_DOCUMENTS	Instance method	Private	Method	Search the documents	20081231

Events

Class CL_SSC_DOCMNT_SEARCH_DISPATCH has no event.

Types

Class CL_SSC_DOCMNT_SEARCH_DISPATCH has no local type.

Method Signatures

Method ADD_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	EV_BAPI_RET	Value transfer	☐	Type reference (TYPE)	BAPIRET2		Return Parameter	20090224

Method ADD_MESSAGE on class CL_SSC_DOCMNT_SEARCH_DISPATCH has no exception.

Method COLLECT_DOCMNT_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_DOCUMENT_ITEM	Call by reference	☐	Type reference (TYPE)	SSC_T_DOCMNT_ITEM		SSC Documents	20090115
2	Exporting	ET_MESSAGE	Call by reference	☐	Type reference (TYPE)	BAPIRET2_T		Return Parameter	20090114

Method COLLECT_DOCMNT_DATA on class CL_SSC_DOCMNT_SEARCH_DISPATCH has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_DOCTYPE	Call by reference	☐	Type reference (TYPE)	SSC_T_DOCTYPE		Table of Doc Type	20090107
2	Importing	IT_QUERY_PARAM	Call by reference	☑	Type reference (TYPE)	SSC_T_QUERY_NAME_VALUE		Query name and value pair	20090129

Method CONSTRUCTOR on class CL_SSC_DOCMNT_SEARCH_DISPATCH has no exception.

Method CONVERT_PARAM_TO_STRUC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_STRUCTURE	Call by reference	☐	Type reference (TYPE)	ANY			20090312
2	Importing	IT_PARAM	Call by reference	☐	Type reference (TYPE)	SSC_T_QUERY_NAME_VALUE		Query name and value pair	20090312

Method CONVERT_PARAM_TO_STRUC on class CL_SSC_DOCMNT_SEARCH_DISPATCH has no exception.

Method GET_ARCHIVE_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_URL	Call by reference	☐	Type reference (TYPE)	SSC_T_DOC_CONTENT_URL		Table of URLs	20090331
2	Exporting	EV_BAPI_RET	Call by reference	☐	Type reference (TYPE)	BAPIRET2		Return Parameter	20090224
3	Exporting	EV_URL_FLAG	Call by reference	☐	Type reference (TYPE)	FLAG		General Flag	20090224
4	Importing	IV_AR_OBJECT	Call by reference	☑	Type reference (TYPE)	TOAOM-AR_OBJECT		Document type	20090827
5	Importing	IV_LINKOBJTYPE	Call by reference	☐	Type reference (TYPE)	SWO_OBJTYP	'FICORR'	SAP BOR Type for GUI Mapping	20090429
6	Importing	IV_OBJKEY	Call by reference	☐	Type reference (TYPE)	SWO_TYPEID		SAP BOR Key	20090226
7	Importing	IV_OBJTYPE	Call by reference	☐	Type reference (TYPE)	SWO_OBJTYP		SAP BOR Type	20090226
8	Importing	IV_RELATIONTYPE	Call by reference	☐	Type reference (TYPE)	BINRELTYP	'FI02'	The Relationship type you use when using relation service	20090429
9	Importing	IV_ROLETYPE	Call by reference	☐	Type reference (TYPE)	ROLETYPE	'APPLOBJ'	Refer to your definition when using relation service	20090429
10	Importing	IX_USE_GUID_MAPPING	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	'X'	indicator for GUID mapping usage	20090306

Method GET_ARCHIVE_INFO on class CL_SSC_DOCMNT_SEARCH_DISPATCH has no exception.

Method GET_COLLECTOR_CLASS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_MESSAGE	Call by reference	☐	Type reference (TYPE)	BAPIRET2_T		Return Parameter	20090114
2	Exporting	EV_CLASSNAME	Call by reference	☐	Type reference (TYPE)	SEOCLSNAME		Object Type Name	20090105
3	Importing	IV_DOCTYPE	Call by reference	☐	Type reference (TYPE)	SSC_DOCTYPE		Document Type	20090105

Method GET_COLLECTOR_CLASS on class CL_SSC_DOCMNT_SEARCH_DISPATCH has no exception.

Method GET_MIMETYPE_BY_DOCTYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID_DOCTYPE	Call by reference	☐	Type reference (TYPE)	TOADD-DOC_TYPE		SAP ArchiveLink: Document class	20090410
2	Returning	RD_MIMETYPE	Value transfer	☐	Type reference (TYPE)	W3CONTTYPE		HTML content type	20090410

Method GET_MIMETYPE_BY_DOCTYPE on class CL_SSC_DOCMNT_SEARCH_DISPATCH has no exception.

Method SEARCH_DOCUMENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_DOCUMENT_ITEM	Call by reference	☐	Type reference (TYPE)	SSC_T_DOCMNT_ITEM		SSC Documents	20090115
2	Exporting	ET_MESSAGE	Call by reference	☐	Type reference (TYPE)	BAPIRET2_T		Return Parameter	20090114
3	Importing	ID_COLLECTORCLASS	Call by reference	☐	Type reference (TYPE)	SEOCLNAME		Class Name	20090304
4	Importing	ID_DOCTYPE	Call by reference	☐	Type reference (TYPE)	SSC_DOCTYPE		Document Type	20090304

Method SEARCH_DOCUMENTS on class CL_SSC_DOCMNT_SEARCH_DISPATCH has no exception.

History

Last changed by/on	SAP	20110908
SAP Release Created in	702