SAP ABAP Interface IF_KMC_INDEX_MGR (Manager for aspect Index)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ EP-KM-WS (Application Component) Embedded Knowledge Management
     ⤷ S_KMC_KM_IDXMGMT (Package) KMC: Indexmanagement Web Service

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	CL_KMC_INDEX_MGR	Manager for aspect Index	20050323

Properties

Interface	IF_KMC_INDEX_MGR
Short Description	Manager for aspect Index

General Data

Package	S_KMC_KM_IDXMGMT	KMC: Indexmanagement Web Service
Created	20050323	SAP
Last changed	20110908	SAP
Unicode checks active	☑

Forward declarations

Interface IF_KMC_INDEX_MGR has no forward declaration.

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_KMC_MANAGER	☐	☐	Marker interface for all managers	20050323

Friends

Interface IF_KMC_INDEX_MGR has no friend.

Attributes

Interface IF_KMC_INDEX_MGR has no attribute.

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ATTACH_DATA_SOURCE	Instance method	Public	Method	Attaches a datasource to an existing index.	20050323
2	CLEAR	Instance method	Public	Method	All documents are removed from the index.	20051115
3	CREATE_INDEX	Instance method	Public	Method	Creates an index.	20050323
4	DEINDEX_RESOURCE	Instance method	Public	Method	Deindexes the resource with the given rid.	20051115
5	DEINDEX_RESOURCES	Instance method	Public	Method	Deindexes the resources with the given rids.	20051115
6	DELETE_INDEX	Instance method	Public	Method	Deletes the specified index.	20050323
7	DELTA_REINDEX	Instance method	Public	Method	Performs reindexing of not yet indexed or changed documents.	20050323
8	DETACH_DATA_SOURCE	Instance method	Public	Method	Detaches a datasource from the given index.	20050323
9	FLUSH_QUEUE	Instance method	Public	Method	Flushes the queue of the given rid.	20050530
10	GET_ALL_INDEX_IDS	Instance method	Public	Method	Returns all index ids of the system.	20051028
11	GET_INDEXED_PROPERTIES	Instance method	Public	Method	Returns the indexed properties for the given indexes.	20051129
12	GET_MANAGER_FACTORY	Instance method	Public	Method	Get Manager Factory	20050323
13	GET_RESOURCE_CONTENT_AS_HTML	Instance method	Public	Method	Returns the resource content as html.	20050530
14	INDEX_RESOURCE	Instance method	Public	Method	Indexes the resource with the given rid.	20051115
15	INDEX_RESOURCES	Instance method	Public	Method	Indexes the resources with the given rids.	20051115
16	REINDEX	Instance method	Public	Method	Triggers reindexing of an existing index.	20050323
17	SEARCH_FIRST_CHUNK_IN_FOLDERS	Instance method	Public	Method	Perfomes a search on one or multiple folders.	20051028
18	SEARCH_FIRST_CHUNK_IN_INDEXES	Instance method	Public	Method	Perfomes a search on one or multiple indexes.	20051028
19	SEARCH_NEXT_CHUNK	Instance method	Public	Method	Returns the next set of matches.	20051028
20	SET_MANAGER_FACTORY	Instance method	Public	Method	Set Manager Factory	20050323

Events

Interface IF_KMC_INDEX_MGR has no event.

Types

Interface IF_KMC_INDEX_MGR has no local type.

Method Signatures

Method ATTACH_DATA_SOURCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_SCHEDULER_TIME_TABLE	Value transfer	☑	Object reference (TYPE REF TO)	IF_KMC_SCHEDULER_TIME_TABLE		The scheduler time table when to let the crawler run.	20050404
2	Importing	I_INDEX_ID	Value transfer	☐	Type reference (TYPE)	STRING		The id of the index to attach the datasource to.	20050323
3	Importing	I_RID	Value transfer	☐	Type reference (TYPE)	STRING		The root rid of the datasource to be attached to the index.	20050323

#	Exception	Resumable	Description	Created on
1	CX_AI_APPLICATION_FAULT	☐	Application Fault	20050323
2	CX_AI_SYSTEM_FAULT	☐	System Fault	20050323
3	CX_KMC_INVALID_PARAMETER	☐	Exception indicating a parameter value constraint violation.	20050323
4	CX_KMC_OPERATION_FAILED	☐	Basic exception indicating a failed Web Service operation.	20050323

Method CLEAR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_INDEX	Value transfer	☐	Type reference (TYPE)	STRING		The index id of the index to clear.	20051115

#	Exception	Resumable	Description	Created on
1	CX_AI_APPLICATION_FAULT	☐	Application Fault	20051115
2	CX_AI_SYSTEM_FAULT	☐	System Fault	20051115
3	CX_KMC_INVALID_PARAMETER	☐	Exception indicating a parameter value constraint violation.	20051115
4	CX_KMC_OPERATION_FAILED	☐	Basic exception indicating a failed Web Service operation.	20051115

Method CREATE_INDEX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_CUSTOM_PROPERTIES	Value transfer	☑	Type reference (TYPE)	KMC_CUSTOM_PROPERTY_TAB		The custom properties (index implementation specific).	20050404
2	Importing	I_CRAWLER_PROFILE_ID	Value transfer	☑	Type reference (TYPE)	STRING		The default crawler id for all index folders.	20050323
3	Importing	I_INDEX_GROUP	Value transfer	☑	Type reference (TYPE)	STRING		The index group, the index belongs to.	20050323
4	Importing	I_INDEX_ID	Value transfer	☐	Type reference (TYPE)	STRING		The index id.	20050404
5	Importing	I_INDEX_NAME	Value transfer	☑	Type reference (TYPE)	STRING		The index name.	20050323
6	Importing	I_SERVICE_ID	Value transfer	☐	Type reference (TYPE)	STRING		The service id.	20050323
7	Importing	I_WHAT_TO_INDEX	Value transfer	☐	Type reference (TYPE)	INT4		Parameter describing what to index.	20050323

#	Exception	Resumable	Description	Created on
1	CX_AI_APPLICATION_FAULT	☐	Application Fault	20050323
2	CX_AI_SYSTEM_FAULT	☐	System Fault	20050323
3	CX_KMC_INVALID_PARAMETER	☐	Exception indicating a parameter value constraint violation.	20050323
4	CX_KMC_OPERATION_FAILED	☐	Basic exception indicating a failed Web Service operation.	20050323

Method DEINDEX_RESOURCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_INDEX	Value transfer	☐	Type reference (TYPE)	STRING		The index id to remove the resource from.	20051115
2	Importing	I_RID	Value transfer	☐	Type reference (TYPE)	STRING		The rid of the resource to deindex.	20051115

#	Exception	Resumable	Description	Created on
1	CX_AI_APPLICATION_FAULT	☐	Application Fault	20051115
2	CX_AI_SYSTEM_FAULT	☐	System Fault	20051115
3	CX_KMC_INVALID_PARAMETER	☐	Exception indicating a parameter value constraint violation.	20051115
4	CX_KMC_OPERATION_FAILED	☐	Basic exception indicating a failed Web Service operation.	20051115

Method DEINDEX_RESOURCES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_RIDS	Value transfer	☐	Type reference (TYPE)	KMCWS_STRING_TAB		The rids of the resources to deindex.	20051115
2	Importing	I_INDEX	Value transfer	☐	Type reference (TYPE)	STRING		The index id to remove the resources from.	20051115

#	Exception	Resumable	Description	Created on
1	CX_AI_APPLICATION_FAULT	☐	Application Fault	20051115
2	CX_AI_SYSTEM_FAULT	☐	System Fault	20051115
3	CX_KMC_INCOMPLETE_DEINDEX	☐	Operation on multiple resources in deindex call failed.	20051115
4	CX_KMC_INVALID_PARAMETER	☐	Exception indicating a parameter value constraint violation.	20051115
5	CX_KMC_OPERATION_FAILED	☐	Basic exception indicating a failed Web Service operation.	20051115

Method DELETE_INDEX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_INDEX_ID	Value transfer	☐	Type reference (TYPE)	STRING		The id of the index to delete.	20050323

#	Exception	Resumable	Description	Created on
1	CX_AI_APPLICATION_FAULT	☐	Application Fault	20050323
2	CX_AI_SYSTEM_FAULT	☐	System Fault	20050323
3	CX_KMC_INVALID_PARAMETER	☐	Exception indicating a parameter value constraint violation.	20050323
4	CX_KMC_OPERATION_FAILED	☐	Basic exception indicating a failed Web Service operation.	20050323

Method DELTA_REINDEX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_INDEX_ID	Value transfer	☐	Type reference (TYPE)	STRING		The id of the index to be reindexed.	20050323

#	Exception	Resumable	Description	Created on
1	CX_AI_APPLICATION_FAULT	☐	Application Fault	20050323
2	CX_AI_SYSTEM_FAULT	☐	System Fault	20050323
3	CX_KMC_INVALID_PARAMETER	☐	Exception indicating a parameter value constraint violation.	20050323
4	CX_KMC_OPERATION_FAILED	☐	Basic exception indicating a failed Web Service operation.	20050323

Method DETACH_DATA_SOURCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_INDEX_ID	Value transfer	☐	Type reference (TYPE)	STRING		The id if the index to detach the datasource from.	20050323
2	Importing	I_RID	Value transfer	☐	Type reference (TYPE)	STRING		The root rid of the datasource to detach from the index.	20050323

#	Exception	Resumable	Description	Created on
1	CX_AI_APPLICATION_FAULT	☐	Application Fault	20050323
2	CX_AI_SYSTEM_FAULT	☐	System Fault	20050323
3	CX_KMC_INVALID_PARAMETER	☐	Exception indicating a parameter value constraint violation.	20050323
4	CX_KMC_OPERATION_FAILED	☐	Basic exception indicating a failed Web Service operation.	20050323

Method FLUSH_QUEUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	E_SUCCESS	Value transfer	☐	Type reference (TYPE)	SAP_BOOL		True if the queue was flushed.	20050530
2	Importing	I_NO_OF_TRIES	Value transfer	☐	Type reference (TYPE)	INT4		No of tries. One try per second.	20050530
3	Importing	I_RID	Value transfer	☐	Type reference (TYPE)	STRING		The rid to flush the queue for.	20050530

#	Exception	Resumable	Description	Created on
1	CX_AI_APPLICATION_FAULT	☐	Application Fault	20050530
2	CX_AI_SYSTEM_FAULT	☐	System Fault	20050530
3	CX_KMC_INVALID_PARAMETER	☐	Exception indicating a parameter value constraint violation.	20050530
4	CX_KMC_OPERATION_FAILED	☐	Basic exception indicating a failed Web Service operation.	20050530

Method GET_ALL_INDEX_IDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ET_INDEX_IDS	Value transfer	☐	Type reference (TYPE)	KMCWS_STRING_TAB		All index ids of the system.	20051028

#	Exception	Resumable	Description	Created on
1	CX_AI_APPLICATION_FAULT	☐	Application Fault	20051028
2	CX_AI_SYSTEM_FAULT	☐	System Fault	20051028
3	CX_KMC_OPERATION_FAILED	☐	Basic exception indicating a failed Web Service operation.	20051028

Method GET_INDEXED_PROPERTIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ET_PROPERTIES	Value transfer	☐	Type reference (TYPE)	KMC_PROPERTY_TAB		The indexed Properties.	20051129
2	Importing	IT_INDEX_IDS	Value transfer	☐	Type reference (TYPE)	KMCWS_STRING_TAB		List of index Ids.	20051129

#	Exception	Resumable	Description	Created on
1	CX_AI_APPLICATION_FAULT	☐	Application Fault	20051129
2	CX_AI_SYSTEM_FAULT	☐	System Fault	20051129
3	CX_KMC_INVALID_PARAMETER	☐	Exception indicating a parameter value constraint violation.	20051129
4	CX_KMC_OPERATION_FAILED	☐	Basic exception indicating a failed Web Service operation.	20051129

Method GET_MANAGER_FACTORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ER_MANAGER_FACTORY	Value transfer	☐	Object reference (TYPE REF TO)	CL_KMC_MANAGER_FACTORY		Reference to Manager Factory	20050323

Method GET_MANAGER_FACTORY on Interface IF_KMC_INDEX_MGR has no exception.

Method GET_RESOURCE_CONTENT_AS_HTML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	E_HTML_CONTENT	Value transfer	☐	Type reference (TYPE)	STRING		The content as html	20050530
2	Importing	IT_QUERY_ENTRIES	Value transfer	☑	Type reference (TYPE)	KMC_QUERY_ENTRY_TAB		The html content is highlighted for this search query.	20050530
3	Importing	I_RID	Value transfer	☐	Type reference (TYPE)	STRING		The resources rid to get the content as html for.	20050530

#	Exception	Resumable	Description	Created on
1	CX_AI_APPLICATION_FAULT	☐	Application Fault	20050530
2	CX_AI_SYSTEM_FAULT	☐	System Fault	20050530
3	CX_KMC_INVALID_PARAMETER	☐	Exception indicating a parameter value constraint violation.	20050530
4	CX_KMC_OPERATION_FAILED	☐	Basic exception indicating a failed Web Service operation.	20050530

Method INDEX_RESOURCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_INDEX	Value transfer	☐	Type reference (TYPE)	STRING		The index id to add the resource to.	20051115
2	Importing	I_RID	Value transfer	☐	Type reference (TYPE)	STRING		The rid of the resource to index.	20051115

#	Exception	Resumable	Description	Created on
1	CX_AI_APPLICATION_FAULT	☐	Application Fault	20051115
2	CX_AI_SYSTEM_FAULT	☐	System Fault	20051115
3	CX_KMC_INVALID_PARAMETER	☐	Exception indicating a parameter value constraint violation.	20051115
4	CX_KMC_OPERATION_FAILED	☐	Basic exception indicating a failed Web Service operation.	20051115

Method INDEX_RESOURCES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_RIDS	Value transfer	☐	Type reference (TYPE)	KMCWS_STRING_TAB		The rids of the resources to index.	20051115
2	Importing	I_INDEX	Value transfer	☐	Type reference (TYPE)	STRING		The index id to add the resources to.	20051115

#	Exception	Resumable	Description	Created on
1	CX_AI_APPLICATION_FAULT	☐	Application Fault	20051115
2	CX_AI_SYSTEM_FAULT	☐	System Fault	20051115
3	CX_KMC_INCOMPLETE_INDEX	☐	Operation on multiple resources in index call failed.	20051115
4	CX_KMC_INVALID_PARAMETER	☐	Exception indicating a parameter value constraint violation.	20051115
5	CX_KMC_OPERATION_FAILED	☐	Basic exception indicating a failed Web Service operation.	20051115

Method REINDEX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_INDEX_ID	Value transfer	☐	Type reference (TYPE)	STRING		The id of the index to be reindexed.	20050323

#	Exception	Resumable	Description	Created on
1	CX_AI_APPLICATION_FAULT	☐	Application Fault	20050323
2	CX_AI_SYSTEM_FAULT	☐	System Fault	20050323
3	CX_KMC_INVALID_PARAMETER	☐	Exception indicating a parameter value constraint violation.	20050323
4	CX_KMC_OPERATION_FAILED	☐	Basic exception indicating a failed Web Service operation.	20050323

Method SEARCH_FIRST_CHUNK_IN_FOLDERS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ER_RESOURCES_CHUNK	Value transfer	☐	Object reference (TYPE REF TO)	IF_KMC_SEARCH_RESULT_CHUNK		Result chunk.	20051028
2	Importing	IR_COLLATOR_ENTRY	Value transfer	☑	Object reference (TYPE REF TO)	IF_KMC_COLLATOR_ENTRY		The collator entry describing the sort behaviour.	20051028
3	Importing	IR_FETCH_GROUP	Value transfer	☑	Object reference (TYPE REF TO)	IF_KMC_FETCH_GROUP		The fetch group.	20051028
4	Importing	IT_LANGUAGES	Value transfer	☑	Type reference (TYPE)	KMCWS_STRING_TAB		A list of languages to filter the results (e.g. 'de', 'en').	20051028
5	Importing	IT_QUERY_ENTRIES	Value transfer	☐	Type reference (TYPE)	KMC_QUERY_ENTRY_TAB		The query entries to search with.	20051028
6	Importing	IT_RIDS	Value transfer	☐	Type reference (TYPE)	KMCWS_STRING_TAB		Folders to search in.	20051028
7	Importing	I_COUNT	Value transfer	☐	Type reference (TYPE)	INT4		Maximum result count.	20051028
8	Importing	I_TIMEOUT	Value transfer	☐	Type reference (TYPE)	INT4		Access timeout.	20051028

#	Exception	Resumable	Description	Created on
1	CX_AI_APPLICATION_FAULT	☐	Application Fault	20051028
2	CX_AI_SYSTEM_FAULT	☐	System Fault	20051028
3	CX_KMC_INVALID_PARAMETER	☐	Exception indicating a parameter value constraint violation.	20051028
4	CX_KMC_OPERATION_FAILED	☐	Basic exception indicating a failed Web Service operation.	20051028

Method SEARCH_FIRST_CHUNK_IN_INDEXES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ER_RESOURCES_CHUNK	Value transfer	☐	Object reference (TYPE REF TO)	IF_KMC_SEARCH_RESULT_CHUNK		Result chunk.	20051028
2	Importing	IR_COLLATOR_ENTRY	Value transfer	☑	Object reference (TYPE REF TO)	IF_KMC_COLLATOR_ENTRY		The collator entry describing the sort behaviour.	20051028
3	Importing	IR_FETCH_GROUP	Value transfer	☑	Object reference (TYPE REF TO)	IF_KMC_FETCH_GROUP		The fetch group.	20051028
4	Importing	IT_INDEX_IDS	Value transfer	☐	Type reference (TYPE)	KMCWS_STRING_TAB		Index ids to search in.	20051028
5	Importing	IT_LANGUAGES	Value transfer	☑	Type reference (TYPE)	KMCWS_STRING_TAB		A list of languages to filter the results (e.g. 'de', 'en').	20051028
6	Importing	IT_QUERY_ENTRIES	Value transfer	☐	Type reference (TYPE)	KMC_QUERY_ENTRY_TAB		The query entries to search with.	20051028
7	Importing	I_COUNT	Value transfer	☐	Type reference (TYPE)	INT4		Maximum result count.	20051028
8	Importing	I_TIMEOUT	Value transfer	☐	Type reference (TYPE)	INT4		Access timeout.	20051028

#	Exception	Resumable	Description	Created on
1	CX_AI_APPLICATION_FAULT	☐	Application Fault	20051028
2	CX_AI_SYSTEM_FAULT	☐	System Fault	20051028
3	CX_KMC_INVALID_PARAMETER	☐	Exception indicating a parameter value constraint violation.	20051028
4	CX_KMC_OPERATION_FAILED	☐	Basic exception indicating a failed Web Service operation.	20051028

Method SEARCH_NEXT_CHUNK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ER_RESOURCES_CHUNK	Value transfer	☐	Object reference (TYPE REF TO)	IF_KMC_SEARCH_RESULT_CHUNK		Result chunk	20051028
2	Importing	I_COUNT	Value transfer	☐	Type reference (TYPE)	INT4		Maximum result count	20051028
3	Importing	I_TOKEN	Value transfer	☐	Type reference (TYPE)	STRING		Access token	20051028

#	Exception	Resumable	Description	Created on
1	CX_AI_APPLICATION_FAULT	☐	Application Fault	20051028
2	CX_AI_SYSTEM_FAULT	☐	System Fault	20051028
3	CX_KMC_INVALID_PARAMETER	☐	Exception indicating a parameter value constraint violation.	20051028
4	CX_KMC_OPERATION_FAILED	☐	Basic exception indicating a failed Web Service operation.	20051028

Method SET_MANAGER_FACTORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_MANAGER_FACTORY	Value transfer	☐	Object reference (TYPE REF TO)	CL_KMC_MANAGER_FACTORY		Reference to Manager Factory	20050323

Method SET_MANAGER_FACTORY on Interface IF_KMC_INDEX_MGR has no exception.

History

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