CATLogicalModelerUseItf  CATLogDeleteServices
Usage: you must use this class as is. You should never derive it.
 public class CATLogDeleteServices
 Class providing services enabling deletion of Logical PLM Components from database.
 
Role: This class provides services to delete Logical PLM Components (in a short transaction) from database.
 Method Index
 
 -  o 
    DeleteLogicalReferences(CATLISTP(CATIAdpPLMIdentificator)&)
-    Deletes a set of Logical References from database.
Methods
 
  o DeleteLogicalReferences
  | public static   DeleteLogicalReferences( |  | iLReferencesToDelete) | 
  - 
  Deletes a set of Logical References from database.
 
 Role: This method deletes a set of Logical References from the database given their PLM Identificators (@see CATIAdpPLMIdentificator).
 PLM Identificators can be retrieved from the result of a Query in the database.
  A Reference can be deleted if it meets the following conditions: 
   
  - The Reference and all its aggregated components are not locked.
- The Reference is not loaded in session (in a long transaction).
- The Reference is not instantiated under a Reference who is outside of the deletion scope.
 
  Deletes a Logical Reference implies the following operations:
   
  -  Deletes all its aggregated Instances.
  
-  Deletes the Reference itself.
  
-  Deletes the Instances coming from the Reference.
  
 If any of the Logical References cannot be deleted, no modification will be performed.
 Deletion is done in short transaction: once done, no rollback is possible.
  -  Parameters:
  
- 
    
    -   iLReferencesToDelete
   
-       A list of PLM Identificator of the Logical References to delete. 
 Input Parameter
 
-  Returns: 
  
-      S_OKif the methods succeeds and the provided Logical References and all the objects belonging to the scope deletion 
                      have been deleted from the database.
 E_INVALIDARGif the input list iLReferencesToDelete is empty or any of the provided elements is 
                              not a Logical Reference.
 E_FAILif at least one of the Logical References can not be deleted from the database.
 In this case, no Logical Reference is deleted. The blocking error can be accessed through 
 protocol.
 
 
 This object is included in the file: CATLogDeleteServices.h
If needed, your Imakefile.mk should include the module: CATLogicalModelerAccessUse
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.