All Frameworks Class Hierarchy This Framework Indexes Previous Next

DataCommonProtocolUse Interface CATIReplace

Usage: you can reimplement this interface by deriving the supplied CATMmrReplaceAdapter adapter class.

interface CATIReplace

Interface to replace the valuation of an attribute by another one.

Role: This interface is dedicated to an internal use and is called during replace operations. It needs to be implemented on any new applicative feature. The implementation should include the additional method GetRequestedBehavior.

See also:: , ,

Method Index

o IsElementValidForReplace(CATUnicodeString&,CATBaseUnknown_var&,CATUnicodeString&,int&,CATBaseUnknown_var&): Determines whether the candidate element is allowed to replace the existing one.
o Replace(CATUnicodeString&,CATBaseUnknown_var&,CATBaseUnknown_var&): Valuates a given attribute with another object.

Methods

o IsElementValidForReplace

public virtual IsElementValidForReplace(	const	`iName`,
	const	`iElement`,
		`oMessage`,
		`oElementValidity`,
	const	`iOldValue`	`= NULL_var`)

Determines whether the candidate element is allowed to replace the existing one.
This method should only be called internally.

Parameters:

iName: name of the attribute whose value is to be replaced.
iElement: candidate element for replace.
oMessage: explains returned HRESULT
oElementValidity: Legal values : 0 if element is not valid ,
1 if element is valid
iOldValue: position of the feature to replace if the attribute is a list.

Returns:

HRESULT
Legal values : S_OK E_FAIL E_NOTIMPL

o Replace

public virtual Replace(	const	`iName`,
		`iElement`,
	const	`iOldValue`	`= NULL_var`)

Valuates a given attribute with another object.
This method should only be called internally.

Parameters:

iName: name of the attribute whose value is to be replaced
iElement: candidate element for replace.
iOldValue: position of the feature to replace if the attribute is a list.

Returns:

HRESULT
Legal values : S_OK E_FAIL E_NOTIMPL

This object is included in the file: CATIReplace.h
If needed, your Imakefile.mk should include the module: CATProviderItf