All Frameworks Class Hierarchy This Framework Indexes Previous Next

KnowledgeInterfaces Interface CATIExposeObject

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

interface CATIExposeObject

Interface to declare Knowledgeware access on objects.
Reserved for CAA Partner.
Role: this interface allows an object to publish its types and attributes values to KnowledgeWare and to the Edit/Find functionality by granting objects with type information.
Implementations of that interface should derive from .

BOA information: this interface CANNOT be implemented using the BOA (Basic Object Adapter). To know more about the BOA, refer to the CAA Encyclopedia home page. Click Middleware at the bottom left, then click the Object Modeler tab page. Several articles deal with the BOA.

See also:: , ,

Method Index

o GetOwner(): Returns the owner of the object (in terms of tree aggregation.
o GetValue(CATUnicodeString&): Gets an attribute value.
o IsSupporting(CATIType_var&): Casts this object to another one supporting the given type.
o ListSupportedTypes(CATListValCATIType_var&): Fills the given list with types supported by this object.
o SetValue(CATUnicodeString&,CATIValue_var&): Sets an attribute value.
o Type(): Returns the main Knowledge type of an object.

Methods

o GetOwner

public virtual GetOwner(

)

Returns the owner of the object (in terms of tree aggregation.
May be NULL. An AddRef is done

Returns:: [CATBaseUnknown#Release] the owner of the object..

o GetValue

public virtual GetValue( const iKey)

Gets an attribute value.
The contract of this method is to retrieve the value from its internal attribute value and return it.
In some contexts a copy may be created. But if the attribute is a parameter, the method is supposed to return the parameter itself.
If the internal attribute value is Unset, the contract of this method is to Unset the attribute value that is returned.

Parameters:

iKey: Name of the attribute.

Returns:

[CATBaseUnknown#Release] iValue Value of the attribute (an AddRef is done, if not NULL).

o IsSupporting

public virtual IsSupporting( const iType)

Casts this object to another one supporting the given type. An AddRef is done, if not NULL.

Parameters:

iType: type we want to cast the object to.

Returns:

[CATBaseUnknown#Release] the object supporting this type (may be NULL or self).

o ListSupportedTypes

public virtual ListSupportedTypes( iolListOfCATIType)

Fills the given list with types supported by this object.
The list in input may not be empty. This method is supposed to add some types to the list.
At least the main type of the object is supposed to be in this list

Parameters:

iolListOfCATIType: the filled list.

Returns:

classic HRESULT

o SetValue

public virtual SetValue(	const	`iKey`,
	const	`iValue`)

Sets an attribute value.
The contract of this method is to copy the value in input in its internal attribute value.
If the value passed as argument is Unset, the contract of this method is to Unset the attribute value (if it makes sense).

Parameters:

iKey: Name of the attribute.
iValue: Value of the attribute.

Returns:

classic HRESULT

o Type

public virtual Type(

)

Returns the main Knowledge type of an object. An AddRef is done.

Returns:: [CATBaseUnknown#Release] the main type of the object.

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