All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

VPMInterfaces Interface CATIVpmObjectPool

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATIVpmObjectPool
 

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATIVpmObjectPool

This interface provides a set of methods to manage a list of VPMObject Pools.
These pools will be used by the ENOVIA LCA applications to share some information. A Pool could be considered as a kind of base of facts by the Business Rules Manager.


Method Index


o ActivateSwitch(CATUnicodeString&,ActivateBase&)
Change the pool activation flag.
o EraseVPMObject(CATUnicodeString&,CATUnicodeString&)
Remove a typed VPMObject from a pool.
o EraseVPMObjectList(CATUnicodeString&,CATUnicodeString&)
Remove a list of typed VPMObjects from a pool.
o Flush(CATUnicodeString&)
Clean a set of variables included into the Pool.
o GetCurrentPool(CATUnicodeString&)
Get the name of a current pool.
o GetListOfVPMObject(CATUnicodeString&,CATListOfCATUnicodeString&)
Get the list of VPMObject names defined in a pool.
o GetVPMObject(CATUnicodeString&,CATUnicodeString&,CATIVpmFactoryObject_var&)
Retrieve a typed VPMObject from a pool.
o GetVPMObjectList(CATUnicodeString&,CATUnicodeString&,CATLISTV(CATIVpmFactoryObject_var)&)
Retrieve typed VPMObjects from a pool.
o IsActivated(CATUnicodeString&)
Query the pool activation status.
o SetCurrentPool(CATUnicodeString&)
Activate a pool as current.
o SetVPMObject(CATUnicodeString&,CATUnicodeString&,CATIVpmFactoryObject_var&,PoolSetMode&)
Add a typed VPMObject to the pool.
o SetVPMObjectList(CATUnicodeString&,CATUnicodeString&,CATLISTV(CATIVpmFactoryObject_var)&,PoolSetMode&)
Add a list of typed VPMObjects.

Methods


o ActivateSwitch
public virtual HRESULT ActivateSwitch( const CATUnicodeString& iPoolName,
const ActivateBase& iActivateFlag) = 0
Change the pool activation flag.
Parameters:
iPoolName
the name of the pool for which you want to change the flag value.
iActivateFlag
the desired value of the flag.
Returns:
An HRESULT value.
Legal values:
S_OK
Activated
E_FAIL
Error raised during processing
o EraseVPMObject
public virtual HRESULT EraseVPMObject( const CATUnicodeString& iPoolName,
const CATUnicodeString& iVPMObjectName)= 0
Remove a typed VPMObject from a pool.
Parameters:
iPoolName
the name of the pool on which to perform the operation.
iVPMObjectName
the type of the VPMObject to remove
Returns:
An HRESULT value.
Legal values:
S_OK
the VPMObject is removed from the pool
S_FALSE
the VPMObject does not exist
E_FAIL
Error raised during processing
o EraseVPMObjectList
public virtual HRESULT EraseVPMObjectList( const CATUnicodeString& iPoolName,
const CATUnicodeString& iVPMObjectName)= 0
Remove a list of typed VPMObjects from a pool.
Parameters:
iPoolName
the name of the pool on which to perform the operation.
iVPMObjectName
the type of the VPMObjects
Returns:
An HRESULT value.
Legal values:
S_OK
The list is removed
S_FALSE
The list does not exist
E_FAIL
Error raised during processing
o Flush
public virtual HRESULT Flush( const CATUnicodeString& iPoolName)= 0
Clean a set of variables included into the Pool.
Parameters:
iPoolName
the name of the pool on which to perform the operation.
Returns:
An HRESULT value.
Legal values:
S_OK
Flush successful
S_FALSE
Pool is empty
E_FAIL
Error raised during processing
o GetCurrentPool
public virtual HRESULT GetCurrentPool(CATUnicodeString& oPoolName)= 0
Get the name of a current pool.
Parameters:
oPoolName
returns the name of the current pool.
Returns:
An HRESULT value.
Legal values:
S_OK
Pool name returned
E_FAIL
Error raised during processing
o GetListOfVPMObject
public virtual HRESULT GetListOfVPMObject( const CATUnicodeString& iPoolName,
CATListOfCATUnicodeString& ioVPMObjectNameList)const =0
Get the list of VPMObject names defined in a pool.
Parameters:
iPoolName
the name of the pool for which to query the list.
ioVPMObjectNameList
the list of VPMObject names.
Returns:
An HRESULT value.
Legal values:
S_OK
Defined VPMObject names returned
S_FALSE
No VPMObject defined
E_FAIL
Error raised during processing
o GetVPMObject
public virtual HRESULT GetVPMObject( const CATUnicodeString& iPoolName,
const CATUnicodeString& iVPMObjectName,
CATIVpmFactoryObject_var& oVPMObject)const = 0
Retrieve a typed VPMObject from a pool.
Parameters:
iPoolName
the name of the pool on which to perform the operation.
iVPMObjectName
the type of the object
oVPMObject
the retrieved VPMObject
Returns:
An HRESULT value.
Legal values:
S_OK
The object exists
S_FALSE
The object does not exist
E_FAIL
Error raised during processing
o GetVPMObjectList
public virtual HRESULT GetVPMObjectList( const CATUnicodeString& iPoolName,
const CATUnicodeString& iVPMObjectName,
CATLISTV(CATIVpmFactoryObject_var)& oListOfVPMObject)const = 0
Retrieve typed VPMObjects from a pool.
Parameters:
iPoolName
the name of the pool on which to perform the operation.
iVPMObjectName
the type of the object
oListOfVPMObject
the list of VPMObjects retrieved
Returns:
An HRESULT value.
Legal values:
S_OK
VPMObjects of given type exist
S_FALSE
No VPMObject of given type found
E_FAIL
Error raised during processing
o IsActivated
public virtual HRESULT IsActivated( const CATUnicodeString& iPoolName)= 0
Query the pool activation status.
Parameters:
iPoolName
the name of the pool for which you want to query the status.
Returns:
An HRESULT value.
Legal values:
S_OK
Is activated
S_FALSE
Not activated
E_FAIL
Error raised during processing
o SetCurrentPool
public virtual HRESULT SetCurrentPool( const CATUnicodeString& iPoolName)= 0
Activate a pool as current.
Parameters:
iPoolName
the name of the pool that is to be activated.
Returns:
An HRESULT value.
Legal values:
S_OK
Pool activated
E_FAIL
Error raised during processing
o SetVPMObject
public virtual HRESULT SetVPMObject( const CATUnicodeString& iPoolName,
const CATUnicodeString& iVPMObjectName,
const CATIVpmFactoryObject_var& iVPMObject,
const PoolSetMode& iSetMode= NOREPLACE )= 0
Add a typed VPMObject to the pool.
Parameters:
iPoolName
the name of the pool on which to perform the operation.
iVPMObjectName
the type of the VPMObject
iVPMObject
the VPMObject to be added
iSetMode
indicates whether existing VPMObject should be replaced or not. (NOREPLACE by default)
Returns:
An HRESULT value.
Legal values:
S_OK
The VPMObject is created
S_FALSE
The VPMObject already exists
E_FAIL
Error raised during processing
o SetVPMObjectList
public virtual HRESULT SetVPMObjectList( const CATUnicodeString& iPoolName,
const CATUnicodeString& iVPMObjectName,
const CATLISTV(CATIVpmFactoryObject_var)& iListOfVPMObject,
const PoolSetMode& iSetMode= NOREPLACE )= 0
Add a list of typed VPMObjects.
Parameters:
iPoolName
the name of the pool on which to perform the operation.
iVPMObjectName
the type of the object
iListOfVPMObject
the VPMObjects to be added
iSetMode
indicates whether existing VPMObjects should be replaced or not. (NOREPLACE by default)
Returns:
An HRESULT value.
Legal values:
S_OK
The list of VPMObjects is created
S_FALSE
The list of VPMObjects already exist
E_FAIL
Error raised during processing

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

Copyright © 2003, Dassault Systèmes. All rights reserved.