All Frameworks  Class Hierarchy  This Framework  Previous  Indexes

ProductStructureInterfaces Interface CATIPrdTransactionalEventMgt

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

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


interface CATIPrdTransactionalEventMgt

Interface allowing a transactional management for move operations.

Role: Sends a dedicated message to all listeners when moving children of the required product reference. This message is then used to put to sleep redraw management.

Warning : the caller has to insure that a call to BeginMoveTransaction must be safely ended with a call to StopMoveTransaction.

Example:
// Assuming that ipProduct is a reference CATIProduct-like object under which instances will be managed in a transactional mode. CATIPrdTransactionalEventMgt* currentDisplay = NULL; rc = ipProduct->QueryInterface(IID_CATIPrdTransactionalEventMgt, (void**) &ipTransactionOnMyProduct); rc = ipTransactionOnMyProduct->StartMoveTransaction(); ... Business logic with several moves on ipProduct children instances ... rc = ipTransactionOnMyProduct->StopMoveTransaction();


Method Index


o StartMoveTransaction()
Starts a transaction for moves.
o StopMoveTransaction()
Stops a transaction for moves.

Methods


o StartMoveTransaction
public virtual HRESULT StartMoveTransaction()= 0
Starts a transaction for moves. Will put to sleep listeners while moving. Warning : needs to be matched with a subsequent call to StopMoveTransaction.
Returns:
E_FAIL internal error, event dispatcher not found. S_OK event sent.
o StopMoveTransaction
public virtual HRESULT StopMoveTransaction()= 0
Stops a transaction for moves. Will awaken listeners once this call has been executed. Warning : needs to be matched with a prior call to StartMoveTransaction.
Returns:
E_FAIL internal error, event dispatcher not found. S_OK event sent.

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

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