SAP ABAP Interface IF_KMC_ARCHIVE_MGR (Manager for aspect Archive)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ EP-KM-WS (Application Component) Embedded Knowledge Management
     ⤷ S_KMC_KM_ARCHIVE (Package) KMC: Archive Services for KM

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	CL_KMC_ARCHIVE_MGR	Manager for aspect Archive	20060316

Properties

Interface	IF_KMC_ARCHIVE_MGR
Short Description	Manager for aspect Archive

General Data

Package	S_KMC_KM_ARCHIVE	KMC: Archive Services for KM
Created	20060316	SAP
Last changed	20110908	SAP
Unicode checks active	☑

Forward declarations

Interface IF_KMC_ARCHIVE_MGR has no forward declaration.

Interfaces

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

Friends

Interface IF_KMC_ARCHIVE_MGR has no friend.

Attributes

Interface IF_KMC_ARCHIVE_MGR has no attribute.

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_RESOURCES_TO_BASKET	Instance method	Public	Method	Adds Resources to be archived to an Archive Basket.	20060316
2	ADD_RESOURCE_TO_BASKET	Instance method	Public	Method	Adds a Resource to be archived to an Archive Basket.	20060316
3	ARCHIVE	Instance method	Public	Method	Archives resources of a basket.	20060316
4	ARCHIVE_IN_ONE_STEP	Instance method	Public	Method	Creates a new ArchiveBasket and archives it immeadeatly.	20060316
5	CREATE_ARCHIVE_BASKET	Instance method	Public	Method	Creates a new ArchiveBasket.	20060316
6	DELETE_ARCHIVE_BASKET	Instance method	Public	Method	Creates a new ArchiveBasket.	20060316
7	GET_ALL_ARCHIVE_BASKETS	Instance method	Public	Method	Returns an array of all existing ArchiveBasket.	20060316
8	GET_ARCHIVE_BASKET	Instance method	Public	Method	Returns an existing ArchiveBasket.	20060316
9	GET_ARCHIVE_STORES	Instance method	Public	Method	Returns a List of Archive Stores.	20060316
10	GET_LOG_FILE_RID	Instance method	Public	Method	Returns the Rid of the logfile for an archive basket.	20060316
11	GET_MANAGER_FACTORY	Instance method	Public	Method	Get Manager Factory	20060316
12	REMOVE_RESOURCES_FROM_BASKET	Instance method	Public	Method	Removes a list of Resources from an Archive Basket.	20060316
13	REMOVE_RESOURCE_FROM_BASKET	Instance method	Public	Method	Removes a Resource from an Archive Basket.	20060316
14	SET_MANAGER_FACTORY	Instance method	Public	Method	Set Manager Factory	20060316
15	SYNCHRONIZE_ARCHIVE_STORES	Instance method	Public	Method	Synchronizes Archive Stores from SLD	20060316

Events

Interface IF_KMC_ARCHIVE_MGR has no event.

Types

Interface IF_KMC_ARCHIVE_MGR has no local type.

Method Signatures

Method ADD_RESOURCES_TO_BASKET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ET_OPERATION_RESULTS	Value transfer	☐	Type reference (TYPE)	KMC_OPERATION_RESULT_TAB		Result of the operation	20060317
2	Importing	IT_RIDS	Value transfer	☐	Type reference (TYPE)	KMCWS_STRING_TAB		Array of Rids to be archived	20060316
3	Importing	I_BASKET_ID	Value transfer	☐	Type reference (TYPE)	STRING		Id of the basket.	20060316

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

Method ADD_RESOURCE_TO_BASKET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ER_OPERATION_RESULT	Value transfer	☐	Object reference (TYPE REF TO)	IF_KMC_OPERATION_RESULT		Result of the operation	20060317
2	Importing	I_BASKET_ID	Value transfer	☐	Type reference (TYPE)	STRING		Id of the basket.	20060316
3	Importing	I_RID	Value transfer	☐	Type reference (TYPE)	STRING		Rids to be archived	20060316

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

Method ARCHIVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ER_BASKET	Value transfer	☐	Object reference (TYPE REF TO)	IF_KMC_ARCHIVE_BASKET		Contains all information of the basket.	20060316
2	Importing	I_BASKET_ID	Value transfer	☐	Type reference (TYPE)	STRING		Id of the new basket to be archived	20060316
3	Importing	I_NAME	Value transfer	☐	Type reference (TYPE)	STRING		Name of the target Folder.	20060316
4	Importing	I_OVERWRITE	Value transfer	☐	Type reference (TYPE)	SAP_BOOL		Overwrite existing resources in target folder.	20060316
5	Importing	I_SYNCHRON	Value transfer	☐	Type reference (TYPE)	SAP_BOOL		Start archive proces synchron or asynchron.	20060316
6	Importing	I_TARGET_RID	Value transfer	☐	Type reference (TYPE)	STRING		Physical target rid of the archive run.	20060316

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

Method ARCHIVE_IN_ONE_STEP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ER_BASKET	Value transfer	☐	Object reference (TYPE REF TO)	IF_KMC_ARCHIVE_BASKET		Contains all information of the basket.	20060316
2	Importing	IT_RIDS	Value transfer	☑	Type reference (TYPE)	KMCWS_STRING_TAB		Resources to be archived	20060316
3	Importing	I_BASKET_ID	Value transfer	☐	Type reference (TYPE)	STRING		Id of the new basket	20060316
4	Importing	I_NAME	Value transfer	☐	Type reference (TYPE)	STRING		Name of the target Folder.	20060316
5	Importing	I_OVERWRITE	Value transfer	☐	Type reference (TYPE)	SAP_BOOL		Overwrite existing resources in target folder.	20060316
6	Importing	I_SYNCHRON	Value transfer	☐	Type reference (TYPE)	SAP_BOOL		Start archive proces synchron or asynchron.	20060316
7	Importing	I_TARGET_RID	Value transfer	☐	Type reference (TYPE)	STRING		Physical target rid of the archive run.	20060316

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

Method CREATE_ARCHIVE_BASKET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ER_ARCHIVE_BASKET	Value transfer	☐	Object reference (TYPE REF TO)	IF_KMC_ARCHIVE_BASKET		ArchiveBasket	20060316
2	Importing	IT_RIDS	Value transfer	☑	Type reference (TYPE)	KMCWS_STRING_TAB		Resources to be archived	20060316
3	Importing	I_BASKET_ID	Value transfer	☐	Type reference (TYPE)	STRING		Id of the new basket	20060316

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

Method DELETE_ARCHIVE_BASKET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_BASKET_ID	Value transfer	☐	Type reference (TYPE)	STRING		Id of the basket to be deleted	20060316

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

Method GET_ALL_ARCHIVE_BASKETS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ET_ARCHIVE_BASKETS	Value transfer	☐	Type reference (TYPE)	KMC_ARCHIVE_BASKET_TAB		ArchiveBasket	20060316

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

Method GET_ARCHIVE_BASKET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ER_ARCHIVE_BASKET	Value transfer	☐	Object reference (TYPE REF TO)	IF_KMC_ARCHIVE_BASKET		ArchiveBasket	20060316
2	Importing	I_BASKET_ID	Value transfer	☐	Type reference (TYPE)	STRING		Id of the basket	20060316

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

Method GET_ARCHIVE_STORES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ET_ARCHIVE_STORES	Value transfer	☐	Type reference (TYPE)	KMC_ARCHIVE_STORE_TAB		Array of Rids of configured Archive Repository Managers.	20060316

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

Method GET_LOG_FILE_RID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	E_RID	Value transfer	☐	Type reference (TYPE)	STRING		Rid of the logfile.	20060316
2	Importing	I_BASKET_ID	Value transfer	☐	Type reference (TYPE)	STRING		Id of the new basket	20060316

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

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	20060316

Method GET_MANAGER_FACTORY on Interface IF_KMC_ARCHIVE_MGR has no exception.

Method REMOVE_RESOURCES_FROM_BASKET 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		Rids to be removed	20060316
2	Importing	I_BASKET_ID	Value transfer	☐	Type reference (TYPE)	STRING		Id of the basket.	20060316

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

Method REMOVE_RESOURCE_FROM_BASKET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_BASKET_ID	Value transfer	☐	Type reference (TYPE)	STRING		Id of the basket.	20060316
2	Importing	I_RID	Value transfer	☐	Type reference (TYPE)	STRING		Rid to be removed	20060316

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

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	20060316

Method SET_MANAGER_FACTORY on Interface IF_KMC_ARCHIVE_MGR has no exception.

Method SYNCHRONIZE_ARCHIVE_STORES Signature

Method SYNCHRONIZE_ARCHIVE_STORES on Interface IF_KMC_ARCHIVE_MGR has no parameter.

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

History

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