SAP ABAP Interface IF_KMC_COLLECTION (Complex type Collection)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ EP-KM-WS (Application Component) Embedded Knowledge Management
     ⤷ S_KMC_BC_RF (Package) KMC: Repository Framework Client API

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	CL_KMC_COLLECTION	Complex type Collection	20050323

Properties

Interface	IF_KMC_COLLECTION
Short Description	Complex type Collection

General Data

Package	S_KMC_BC_RF	KMC: Repository Framework Client API
Created	20050323	SAP
Last changed	20110908	SAP
Unicode checks active	☑

Forward declarations

Interface IF_KMC_COLLECTION has no forward declaration.

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_KMC_RESOURCE	☐	☐	Complex type Resource	20050323

Friends

Interface IF_KMC_COLLECTION has no friend.

Attributes

Interface IF_KMC_COLLECTION has no attribute.

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	COUNT_RESOURCES	Instance method	Public	Method	Count resources below a root resource (incl. queries/sort).	20050323
2	CREATE_COLLECTION	Instance method	Public	Method	Create a collection.	20050323
3	CREATE_DOCUMENT	Instance method	Public	Method	Create a document.	20050323
4	CREATE_LINK	Instance method	Public	Method	Create a link.	20050323
5	FIND_RESOURCES	Instance method	Public	Method	Find resources below a root resource (incl. queries/sort).	20050323
6	FIND_RESOURCES_FIRST_CHUNK	Instance method	Public	Method	Page resources below a root resource (incl. queries/sort).	20050323
7	FIND_RESOURCES_NEXT_CHUNK	Instance method	Public	Method	Page resources below a root resource (incl. queries/sort).	20050323
8	GET_CHILDREN	Instance method	Public	Method	Get all direct child resources.	20050323
9	GET_COLLECTION_ORDER_MECHANISM	Instance method	Public	Method	Returns the order mechanism of a collection.	20050323
10	GET_MANAGER_FACTORY	Instance method	Public	Method	Get Manager Factory	20050323
11	REORDER_COLLECTION	Instance method	Public	Method	Reorder children of a resource collection.	20050323
12	SEARCH_FIRST_RESULT_CHUNK	Instance method	Public	Method	TREX Search on Folder	20050531
13	SEARCH_NEXT_RESULT_CHUNK	Instance method	Public	Method	TREX Search on Folder	20050531
14	SET_COLLECTION_ORDER_MECHANISM	Instance method	Public	Method	Change the order mechanism of a collection.	20050323
15	SET_MANAGER_FACTORY	Instance method	Public	Method	Set Manager Factory	20050323

Events

Interface IF_KMC_COLLECTION has no event.

Types

Interface IF_KMC_COLLECTION has no local type.

Method Signatures

Method COUNT_RESOURCES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	E_NUMBER	Value transfer	☐	Type reference (TYPE)	INT4		Number of resources	20050323
2	Importing	IR_FIND_DESCRIPTOR	Value transfer	☐	Object reference (TYPE REF TO)	IF_KMC_FIND_DESCRIPTOR		Find resources descriptor	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 CREATE_COLLECTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ER_RESOURCE	Value transfer	☐	Object reference (TYPE REF TO)	IF_KMC_RESOURCE		Created collection resource	20050323
2	Importing	IR_FETCH_GROUP	Value transfer	☑	Object reference (TYPE REF TO)	IF_KMC_FETCH_GROUP		Fetch group	20050323
3	Importing	IR_LOCK_DESCRIPTOR	Value transfer	☑	Object reference (TYPE REF TO)	IF_KMC_LOCK_DESCRIPTOR		Lock descriptor	20050323
4	Importing	IR_ORDER_MECHANISM	Value transfer	☑	Object reference (TYPE REF TO)	IF_KMC_ORDER_MECHANISM		Order mechanism	20050323
5	Importing	IR_ORDER_POSITION	Value transfer	☑	Object reference (TYPE REF TO)	IF_KMC_ORDER_POSITION		Order position	20050323
6	Importing	IT_PROPERTIES	Value transfer	☑	Type reference (TYPE)	KMC_PROPERTY_TAB		Properties	20050323
7	Importing	I_CHILD_NAME	Value transfer	☐	Type reference (TYPE)	STRING		Child name	20050323
8	Importing	I_OVERWRITE_ENFORCED	Value transfer	☐	Type reference (TYPE)	SAP_BOOL		Overwrite enforced	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 CREATE_DOCUMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ER_RESOURCE	Value transfer	☐	Object reference (TYPE REF TO)	IF_KMC_RESOURCE		Created document resource	20050323
2	Importing	IR_CONTENT	Value transfer	☑	Object reference (TYPE REF TO)	IF_KMC_CONTENT		Content	20050323
3	Importing	IR_FETCH_GROUP	Value transfer	☑	Object reference (TYPE REF TO)	IF_KMC_FETCH_GROUP		Fetch group	20050323
4	Importing	IR_LOCK_DESCRIPTOR	Value transfer	☑	Object reference (TYPE REF TO)	IF_KMC_LOCK_DESCRIPTOR		Lock descriptor	20050323
5	Importing	IR_ORDER_POSITION	Value transfer	☑	Object reference (TYPE REF TO)	IF_KMC_ORDER_POSITION		Order position	20050323
6	Importing	IT_PROPERTIES	Value transfer	☑	Type reference (TYPE)	KMC_PROPERTY_TAB		Properties	20050323
7	Importing	I_CHILD_NAME	Value transfer	☐	Type reference (TYPE)	STRING		Child name	20050323
8	Importing	I_OVERWRITE_ENFORCED	Value transfer	☐	Type reference (TYPE)	SAP_BOOL		Overwrite enforced	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 CREATE_LINK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ER_RESOURCE	Value transfer	☐	Object reference (TYPE REF TO)	IF_KMC_RESOURCE		Created link resource	20050323
2	Importing	IR_FETCH_GROUP	Value transfer	☑	Object reference (TYPE REF TO)	IF_KMC_FETCH_GROUP		Fetch group	20050323
3	Importing	IR_LINK_DESCRIPTOR	Value transfer	☐	Object reference (TYPE REF TO)	IF_KMC_LINK_DESCRIPTOR		Link descriptor	20050323
4	Importing	IR_LOCK_DESCRIPTOR	Value transfer	☑	Object reference (TYPE REF TO)	IF_KMC_LOCK_DESCRIPTOR		Lock descriptor	20050323
5	Importing	IR_ORDER_POSITION	Value transfer	☑	Object reference (TYPE REF TO)	IF_KMC_ORDER_POSITION		Order position	20050323
6	Importing	IT_PROPERTIES	Value transfer	☑	Type reference (TYPE)	KMC_PROPERTY_TAB		Properties	20050323
7	Importing	I_CHILD_NAME	Value transfer	☐	Type reference (TYPE)	STRING		Child name	20050323
8	Importing	I_OVERWRITE_ENFORCED	Value transfer	☐	Type reference (TYPE)	SAP_BOOL		Overwrite enforced	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 FIND_RESOURCES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ET_RESOURCES	Value transfer	☐	Type reference (TYPE)	KMC_RESOURCE_TAB		Array of resources	20050323
2	Importing	IR_FETCH_GROUP	Value transfer	☑	Object reference (TYPE REF TO)	IF_KMC_FETCH_GROUP		Fetch group	20050323
3	Importing	IR_FIND_DESCRIPTOR	Value transfer	☐	Object reference (TYPE REF TO)	IF_KMC_FIND_DESCRIPTOR		Find resources descriptor	20050323
4	Importing	I_INCLUDE_INVALID_RESOURCES	Value transfer	☐	Type reference (TYPE)	SAP_BOOL		Include invalid resources	20050530

#	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 FIND_RESOURCES_FIRST_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_RESOURCES_CHUNK		Resources chunk	20050323
2	Importing	IR_FETCH_GROUP	Value transfer	☑	Object reference (TYPE REF TO)	IF_KMC_FETCH_GROUP		Fetch group	20050323
3	Importing	IR_FIND_DESCRIPTOR	Value transfer	☐	Object reference (TYPE REF TO)	IF_KMC_FIND_DESCRIPTOR		Find resources descriptor	20050323
4	Importing	I_COUNT	Value transfer	☐	Type reference (TYPE)	INT4		Maximum result count	20050323
5	Importing	I_INCLUDE_INVALID_RESOURCES	Value transfer	☐	Type reference (TYPE)	SAP_BOOL		Include invalid resources	20050530
6	Importing	I_TIMEOUT	Value transfer	☐	Type reference (TYPE)	INT4		Access timeout	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 FIND_RESOURCES_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_RESOURCES_CHUNK		Resources chunk	20050323
2	Importing	I_COUNT	Value transfer	☐	Type reference (TYPE)	INT4		Maximum result count	20050323
3	Importing	I_TOKEN	Value transfer	☐	Type reference (TYPE)	STRING		Access token	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 GET_CHILDREN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ET_RESOURCES	Value transfer	☐	Type reference (TYPE)	KMC_RESOURCE_TAB		Array of resources	20050323
2	Importing	IR_FETCH_GROUP	Value transfer	☑	Object reference (TYPE REF TO)	IF_KMC_FETCH_GROUP		Fetch group	20050323
3	Importing	I_INCLUDE_INVALID_RESOURCES	Value transfer	☐	Type reference (TYPE)	SAP_BOOL		Include invalid resources	20050531

#	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 GET_COLLECTION_ORDER_MECHANISM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ER_ORDER_MECHANISM	Value transfer	☐	Object reference (TYPE REF TO)	IF_KMC_ORDER_MECHANISM		Order mechanism	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_OPERATION_FAILED	☐	Basic exception indicating a failed Web Service operation.	20050323

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_COLLECTION has no exception.

Method REORDER_COLLECTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_ORDER_OPERATIONS	Value transfer	☐	Type reference (TYPE)	KMC_ORDER_OPERATION_TAB		Array of order operations	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_RESULT_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.	20050531
2	Importing	IR_COLLATOR_ENTRY	Value transfer	☑	Object reference (TYPE REF TO)	IF_KMC_COLLATOR_ENTRY		The collator entry describing the sort behaviour.	20050531
3	Importing	IR_FETCH_GROUP	Value transfer	☑	Object reference (TYPE REF TO)	IF_KMC_FETCH_GROUP		The fetch group.	20050531
4	Importing	IT_QUERY_ENTRIES	Value transfer	☐	Type reference (TYPE)	KMC_QUERY_ENTRY_TAB		The query entries to search with.	20050531
5	Importing	I_COUNT	Value transfer	☐	Type reference (TYPE)	INT4		Maximum result count.	20050531
6	Importing	I_TIMEOUT	Value transfer	☐	Type reference (TYPE)	INT4		Access timeout.	20050531

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

Method SEARCH_NEXT_RESULT_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	20050531
2	Importing	I_COUNT	Value transfer	☐	Type reference (TYPE)	INT4		Maximum result count	20050531
3	Importing	I_TOKEN	Value transfer	☐	Type reference (TYPE)	STRING		Access token	20050531

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

Method SET_COLLECTION_ORDER_MECHANISM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_ORDER_MECHANISM	Value transfer	☐	Object reference (TYPE REF TO)	IF_KMC_ORDER_MECHANISM		Order mechanism	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 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_COLLECTION has no exception.

History

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