All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ENOVInterfaces Interface CATIEnovCMManager

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

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


interface CATIEnovCMManager

Interface for Change Management Modeler Manager.

Role: This interface is implemented in ENOVInterfaces/ProtectedInterfaces. Customers must use this interface with the provided implementation.


Method Index


o CreateEffectivity(CORBAAny&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATIEnovCMEffectivity_var&)
Creates a Effectivity for an ECO.
o DeleteEffectivity(CORBAAny&)
Deletes an Effectivity for an ECO.
o FindAffectedObject(CATIVpmFactoryObject_var&,CATLISTV(CATIVpmAFLAffectedObject_var)&,CATLISTV(CATIEnovCMEco_var)&)
Returns the Affected Objects list and CO list given the real object (Part, Doc etc.
o FindAffectedObject(CATIVpmFactoryObject_var&,CATLISTV(CATIVpmAFLAffectedObject_var)&,CATLISTV(CATIVpmAFLAction_var)&)
Returns the Affected Objects list and Actions list given the real object (Part, Doc etc.
o FindAffectedObject(CATIVpmFactoryObject_var&,CATLISTV(CATIVpmAFLAffectedObject_var)&,CATLISTV(CATIVpmFactoryObject_var)&)
Returns the Affected Objects list and CR list given the real object (Part, Doc etc.
o FindECOECRACTIONForSubobjects(SEQUENCE(octet)&,CATUnicodeString,CATListValCATIVpmAFLAction_var&)
Finds a Action/ECR/ECR for subobjects, this function can be used to get the list of actions which later can be cast to ECO/ECR/ACTION for the given UUID of the subobject like Attachment/AffectedObject (ex: Documents & Parts).
o FindEcoVer(CATUnicodeString&,CATLISTV(CATIEnovCMEco_var)&)
Finds all the versions of a specified ECO.
o FindOneEco(CATUnicodeString&,CATIEnovCMEco_var&,CATUnicodeString&)
Finds a specified ECO.
o FindPrevEcoVer(CATIVpmAFLAction_var&,CATLISTV(CATIEnovCMEco_var)&)
Finds all the previous versions of a specified ECO.
o GetCOPSpecRelationships(CATIAVPMProductSpecification_var,CATLISTV(CATIEnovCMEco_var)&,CATListOfCATUnicodeString&)
Returns the list of COs and status of Product Spec Affected Objects.
o LogHistory(CATIEnovCMEco_var&,CATUnicodeString&,CATUnicodeString&,CATIVpmAFLHistory_var&)
Keeps history of ECO object.
o PropagateCMEffectivity(CORBAAny&,int)
Propagates CM Effectivity defined in ECO to its deliverables.
o QueryProduct(CATUnicodeString&)
Finds a specified Product.
o TransferECO(CATIEnovCMEco_var&,CATUnicodeString&,boolean&,CATUnicodeString&)
Transfers ECO to a new owner.
o UpdateEffectivity(CORBAAny&,CATUnicodeString&)
Updates Effectivity.
o getEffList(CORBAAny&,CATLISTV(CATIEnovCMEffectivity_var)&)
Gets Effectivity List.

Methods


o CreateEffectivity
public virtual HRESULT CreateEffectivity( const CORBAAny& iEcoUuid,
const CATUnicodeString& iProdId,
const CATUnicodeString& iCfgId,
const CATUnicodeString& iDveId,
CATIEnovCMEffectivity_var& oNewEff)=0
Creates a Effectivity for an ECO.
Parameters:
iEcoUuid
UUID of ECO
iProdId
ID of Product
iCfgId
ID Configurable View
iDveId
ID of Deliverable
oNewEff
Returned New Effectivity Object
o DeleteEffectivity
public virtual HRESULT DeleteEffectivity( const CORBAAny& iUuid)=0
Deletes an Effectivity for an ECO.
Parameters:
Uuid
UUID of Effectivity
o FindAffectedObject
public virtual HRESULT FindAffectedObject( const CATIVpmFactoryObject_var& iRealObject,
CATLISTV(CATIVpmAFLAffectedObject_var)& oAffObject,
CATLISTV(CATIEnovCMEco_var)& oCO)=0
Returns the Affected Objects list and CO list given the real object (Part, Doc etc.,) as input.
Parameters:
iRealObject
Part, Document, PRC, Item Instance etc., that is linked to a CO as an Affected Object
oAffObjectList
Affected Objects on oCOList that has a link to iRealObject. Each Aff Obj in oAffObjList has a parent CO in the oCOList
oCOList
Change Order Objects that aff object in oAffObjectList is linked to. Please do not re order the lists
o FindAffectedObject
public virtual HRESULT FindAffectedObject( const CATIVpmFactoryObject_var& iRealObject,
CATLISTV(CATIVpmAFLAffectedObject_var)& oAffObject,
CATLISTV(CATIVpmAFLAction_var)& oAction)=0
Returns the Affected Objects list and Actions list given the real object (Part, Doc etc.,) as input.
Parameters:
iRealObject
Part, Document, PRC, Item Instance etc., that is linked to Action as an Affected Object
oAffObjectList
Affected Objects on oActionList that has a link to iRealObject. Each Aff Obj in oAffObjList has a parent Action in oActionList
oAction
Action Objects that aff object in oAffObjectList is linked to. Please do not re order the lists
o FindAffectedObject
public virtual HRESULT FindAffectedObject( const CATIVpmFactoryObject_var& iRealObject,
CATLISTV(CATIVpmAFLAffectedObject_var)& oAffObjectList,
CATLISTV(CATIVpmFactoryObject_var)& oCRList)=0
Returns the Affected Objects list and CR list given the real object (Part, Doc etc.,) as input.
Parameters:
iRealObject
Part, Document, PRC, Item Instance etc., that is linked to a CR as an Affected Object
oAffObjectList
Affected Objects on oCRList that has a link to iRealObject. Each Aff Obj in oAffObjList has a parent CR in the oCRList
oCRList
Change Request Objects that Aff Object in oAffObject is linked to . Callers can later convert this to CATIVpmAFLAction object and use it as a Change Request object. Please do not reorder the lists
o FindECOECRACTIONForSubobjects
public virtual HRESULT FindECOECRACTIONForSubobjects( const SEQUENCE(octet)& iECOSubOBJID,
CATUnicodeString iEntityName,
CATListValCATIVpmAFLAction_var& oListAction)=0
Finds a Action/ECR/ECR for subobjects, this function can be used to get the list of actions which later can be cast to ECO/ECR/ACTION for the given UUID of the subobject like Attachment/AffectedObject (ex: Documents & Parts).
Parameters:
iECOSubOBJID
UUID of the subobject
iEntityName
Entity to Query must be ECO/ECR/AFLAction
oListAction
returned AFLAction list
o FindEcoVer
public virtual HRESULT FindEcoVer( const CATUnicodeString& iECOid1,
CATLISTV(CATIEnovCMEco_var)& oListOfEcos)=0
Finds all the versions of a specified ECO.
Parameters:
iECOid1
ID ECO to be found

oListOfEcos
Returned list of ECOs
o FindOneEco
public virtual HRESULT FindOneEco( const CATUnicodeString& iECOid1,
CATIEnovCMEco_var& oEco,
const CATUnicodeString& iECOVer)=0
Finds a specified ECO.
Parameters:
iECOid1
ID ECO to be found
oEco
Returned ECO
iECOVer
Version of ECO
o FindPrevEcoVer
public virtual HRESULT FindPrevEcoVer( const CATIVpmAFLAction_var& iAction,
CATLISTV(CATIEnovCMEco_var)& oListOfEcos)=0
Finds all the previous versions of a specified ECO.
Parameters:
iAction
ECO for which all previous versions are to be found

oListOfEcos
Returned list of ECOs
o GetCOPSpecRelationships
public virtual HRESULT GetCOPSpecRelationships( const CATIAVPMProductSpecification_var iPSpec,
CATLISTV(CATIEnovCMEco_var)& oCOList,
CATListOfCATUnicodeString& oStatusList)=0
Returns the list of COs and status of Product Spec Affected Objects.
Parameters:
iPSpec
Product Specification Object
oCOList
List of Change Orders that have a link to iPSpec as an Affected Object
o LogHistory
public virtual HRESULT LogHistory(CATIEnovCMEco_var& iFromObject,
const CATUnicodeString& iHistoryType,
const CATUnicodeString& iHistoryDescription,
CATIVpmAFLHistory_var& oHistoryInstance)=0
Keeps history of ECO object.
Parameters:
iFromObject
ECO object
iHistoryType
Current action performed
iHistoryDescription
Description of history
oHistoryInstance
CATIVPM AFL history object
o PropagateCMEffectivity
public virtual HRESULT PropagateCMEffectivity( const CORBAAny& iEcoUid,
const int migrate= 0)=0
Propagates CM Effectivity defined in ECO to its deliverables.
Parameters:
iEcoUid
UUID of ECO
o QueryProduct
public virtual HRESULT QueryProduct( const CATUnicodeString& iProdId)=0
Finds a specified Product.
Parameters:
iProdId
ID of Product
o TransferECO
public virtual HRESULT TransferECO( const CATIEnovCMEco_var& iEco,
const CATUnicodeString& iNewOwner,
const boolean& iTrfDels,
const CATUnicodeString& iHistoryDesc)=0
Transfers ECO to a new owner.
Parameters:
iEco
The ECO object
iNewOwner
ID New Owner
iTrfDels
Boolean value for whether Deliverables should be transferred
Legal values: True or False
iHistoryDesc
History description to be stored
o UpdateEffectivity
public virtual HRESULT UpdateEffectivity( const CORBAAny& iUuid,
const CATUnicodeString& iDveId)=0
Updates Effectivity.
Parameters:
iUuid
UUID of Effectivity
iDveId
ID of Deliverable to be updated
o getEffList
public virtual HRESULT getEffList( const CORBAAny& iUuid,
CATLISTV(CATIEnovCMEffectivity_var)& oListOfEff)=0
Gets Effectivity List.
Parameters:
iUuid
UUID of ECO
oListOfEff
Returned List of Effectivity Objects

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

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