All Frameworks Class Hierarchy This Framework Previous Next Indexes
KnowledgeInterfaces Interface CATIInstance
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIInstance
Usage: you can reimplement this interface by deriving the supplied CATKweInstanceAdapter adapter class.
interface CATIInstance
Interface dedicated to manipulating objects in Knowledgeware.
Role: this interface allows one to make his objects utilizable
in KnowledgeWare and in Search by granting objects with static type information
and event reactiveness.
If you want to add dynamic type information, have a look to CATIDynamicAttributes and be sure to make these two interfaces implementations coherent
.
Implementations of that interface should derive from CATKweInstanceAdapter.
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:
- CATIDynamicAttributes
- See also:
- CATIType
- See also:
- CATIValue
Method Index
- o
AdviseAttributeChanged(CATUnicodeString&,CATIValue_var&)
- Propagates an attribute value change event on all the listeners of the instance.
- o
AdviseDynamicAttributeAdded(CATUnicodeString&,CATIValue_var&)
- Propagates a dynamic attribute add event on all the listeners of the instance.
- o
AdviseDynamicAttributeRemoved(CATUnicodeString&,CATIValue_var&)
- Propagates a dynamic attribute remove event on all the listeners of the instance.
- o
AdviseDynamicAttributeRenamed(CATUnicodeString&,CATUnicodeString&)
- Propagates a dynamic attribute rename event on all the listeners of the instance.
- o
AdviseModification()
- Propagates an instance modification event on all the listeners of the instance.
- o
AdviseRemoved()
- Propagates an instance remove event on all the listeners of the instance.
- o
AdviseSpecificEvent(CATBaseUnknown_var&,CATListValCATBaseUnknown_var&)
- Propagates a specific event that occured on the instance.
- o
AdviseTypeChanged()
- Propagates an instance type modification event on all the listeners of the instance.
- o
GetOwner()
- Returns the owner of the instance.
- o
GetValue(CATUnicodeString&)
- Gets an attribute value.
- o
IsSupporting(CATIType_var&)
- Casts an instance to another one supporting the given type.
- o
ListSupportedTypes(CATListValCATIType_var&)
- Fills the given list with types supported by this instance.
- o
SetValue(CATUnicodeString&,CATIValue_var&)
- Sets an attribute value.
- o
Type()
- Returns the main type of an object.
Methods
o AdviseAttributeChanged
-
Propagates an attribute value change event on all the listeners of the instance.
- Parameters:
-
- iKey
- Name of the attribute to monitor.
- iValue
- Value of the attribute.
o AdviseDynamicAttributeAdded
-
Propagates a dynamic attribute add event on all the listeners of the instance.
- Parameters:
-
- iKey
- Name of the added attribute.
- iValue
- Value of the attribute.
o AdviseDynamicAttributeRemoved
-
Propagates a dynamic attribute remove event on all the listeners of the instance.
- Parameters:
-
- iKey
- Name of the removed attribute.
- iValue
- Value of the attribute.
o AdviseDynamicAttributeRenamed
-
Propagates a dynamic attribute rename event on all the listeners of the instance.
- Parameters:
-
- iKey
- Name of the renamed attribute.
- iValue
- Value of the attribute.
o AdviseModification
public virtual HRESULT AdviseModification( | )=0 |
-
Propagates an instance modification event on all the listeners of the instance.
o AdviseRemoved
public virtual HRESULT AdviseRemoved( | )=0 |
-
Propagates an instance remove event on all the listeners of the instance.
o AdviseSpecificEvent
-
Propagates a specific event that occured on the instance.
- Parameters:
-
- iEvent
- Event that happened.
- iList
- List of values carried by the event.
o AdviseTypeChanged
public virtual HRESULT AdviseTypeChanged( | )=0 |
-
Propagates an instance type modification event on all the listeners of the instance.
o GetOwner
-
Returns the owner of the instance.
o GetValue
-
Gets an attribute value.
- Parameters:
-
- iKey
- Name of the attribute.
- Returns:
- iValue Value of the attribute (an AddRef is done, if not NULL).
o IsSupporting
public virtual CATIInstance* IsSupporting( | const CATIType_var& | iType)const = 0 |
-
Casts an instance to another one supporting the given type.
An AddRef is done, if not NULL.
- Parameters:
-
- iType
- type we want to cast the instance to.
- Returns:
- the instance supporting this type (may be NULL or self).
o ListSupportedTypes
public virtual HRESULT ListSupportedTypes( | CATListValCATIType_var& | iolListOfCATIType)const = 0 |
-
Fills the given list with types supported by this instance.
- Parameters:
-
- iolListOfCATIType
- the filled list.
o SetValue
-
Sets an attribute value.
- Parameters:
-
- iKey
- Name of the attribute.
- iValue
- Value of the attribute.
o Type
-
Returns the main type of an object.
An AddRef is done.
- Returns:
- the main type of the object.
This object is included in the file: CATIInstance.h
If needed, your Imakefile.mk should include the module: KnowledgeItf