All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

VPMInterfaces Interface CATICfgModification

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

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


interface CATICfgModification

Interface to manage the Effectivity expressions.
Role: This interface can be used to create,query or manage the effectivity expressions across all domains. Any instance of a class implementing CATIVpmFactoryManager ( CATIVpmFactoryManager ) a DS component (like CATICfgManager) can be used to query for the implementation of this interface.

See also:
CATICfgManager


Method Index


o AttachExtension(SEQUENCE(octet)&)
Make an Extension on a given UUID-Object for this ModificationEffectivity.
o AttachMinus(SEQUENCE(octet)&)
Attach in "-" a given UUID-Object to this ModificationEffectivity.
o AttachPlus(SEQUENCE(octet)&)
Attach in "+" a given UUID-Object to this ModificationEffectivity.
o Detach(SEQUENCE(octet)&)
Detach a given UUID-Object from this ModificationEffectivity: it is no more pointed out in "+" or in "-" by the ModificationEffectivity.
o DetachWithHSE(CATILinkableObject_var&)
Detach a given Object from this ModificationEffectivity: it is no more pointed out in "+" or in "-" by the ModificationEffectivity.
o Duplicate(CATIConfigurableObject_var&,CATICfgModification_var&)
Duplicate this ModificationEffectivity: the copy is owned by an input ConfigurableObject.
o GetAllHistories(CATListValCATICfgHistory_var&,CATUnicodeString&)
Return all Histories for this ModificationEffectivity.
o GetAttachedObjectsExtension(SEQUENCE(CORBAAny)&)
Return the List of Objects attached in "r" to this ModificationEffectivity.
o GetAttachedObjectsMinus(SEQUENCE(CORBAAny)&)
Return the List of Objects attached in "-" to this ModificationEffectivity.
o GetAttachedObjectsPlus(SEQUENCE(CORBAAny)&)
Return the List of Objects attached in "+" to this ModificationEffectivity.
o GetConfigurableObject(CATIConfigurableObject_var&)
Return the ConfigurableObject owning this ModificationEffectivity.
o GetGroupMod(CATICfgGroupModif_var&)
Returns the Group Modification associated to the Modification.
o GetListOfAttachedObjects(SEQUENCE(CORBAAny)&)
Return the List of all the Objects attached in "+" or in "-" to this ModificationEffectivity.
o GetModState(CATICfgModification::ModState&)
Return the State of the ModificationEffectivity.
o GetName(CATUnicodeString&)
Return the Name of the ModificationEffectivity.
o GetParent(CATICfgModification_var&)
Return this modification's parent.
o GetSuperseded(CATListValCATICfgModification_var&)
Retrieve the List of ModificationEffectivities superseded by this ModificationEffectivity.
o GetX_Eff(CATUnicodeString&,CATICfgORExpression_var&)
Return the Effectivity (as an ORExression) associated to this ModificationEffectivity, given its DomainName.
o GetX_EffList(CATListOfCATUnicodeString&,CATListValCATICfgORExpression_var&,int)
Return the List of Effectivities (as ORExpressions) associated to this ModificationEffectivity.
o IsAttachedMinus(SEQUENCE(octet)&)
Check if a given UUID-Object is attached in "-" to this ModificationEffectivity.
o IsAttachedPlus(SEQUENCE(octet)&)
Check if a given UUID-Object is attached in "+" to this ModificationEffectivity.
o Modify(CATICfgModification::Operation,CATILinkableObject_var&,CATILinkableObject_var&,int&)
Use this ModificationEffectivity to execute an operation on UUID-Objects.
o Modify(CATICfgModification::Operation,SEQUENCE(octet)&,SEQUENCE(octet)&,int&)
Use this ModificationEffectivity to execute an operation on UUID-Objects.
o PointsTo(CATILinkableObject_var&,int&)
To find out if this modification points to an object
o RemoveX_Eff(CATUnicodeString&)
Remove an Effectivity, given its DomainName, from this ModificationEffectivity.
o RemoveX_Effectivity(CATUnicodeString&)
Remove an Effectivity from this ModificationEffectivity for a given DomainName.
o ResetParent()
Break the link between this modification and its parent.
o SetName(CATUnicodeString&)
Set the name of this modification.
o SetParent(CATICfgModification_var&)
Link this modification to another one to create a parent-child relationship.
o SetVisible(CATBoolean)
Set visibility of this modification (which is invisibble by default).
o SetX_Eff(CATUnicodeString&,CATICfgORExpression_var&)
Set an Effectivity (as an ORExpression) to this ModificationEffectivity.
o SetX_Effectivity(CATUnicodeString&,CATICfgEffectivity_var&)
Set an Effectivity to this ModificationEffectivity for a given DomainName.
o Supersede(CATListValCATICfgModification_var&)
This ModificationEffectivity supersedes an input List of ModificationEffectivities: to be used when you cannot update the Effecivity of the ModificationEffectivities in iListMod.
o UpdateEffectivity()
Update effectivities of all objects where this modification is involved.

Methods


o AttachExtension
public virtual HRESULT AttachExtension( const SEQUENCE(octet)& iObjectUUID) = 0
Make an Extension on a given UUID-Object for this ModificationEffectivity.
Parameters:
iObjectUUID
UUID of the Object.
o AttachMinus
public virtual HRESULT AttachMinus( const SEQUENCE(octet)& iObjectUUID) = 0
Attach in "-" a given UUID-Object to this ModificationEffectivity.
Parameters:
iObjectUUID
UUID of the Object.
o AttachPlus
public virtual HRESULT AttachPlus( const SEQUENCE(octet)& iObjectUUID) = 0
Attach in "+" a given UUID-Object to this ModificationEffectivity.
Parameters:
iObjectUUID
UUID of the Object.
o Detach
public virtual HRESULT Detach(SEQUENCE(octet)& iObjectUUID) = 0
Detach a given UUID-Object from this ModificationEffectivity: it is no more pointed out in "+" or in "-" by the ModificationEffectivity.
Parameters:
iObjectUUID
UUID of the Object to detach.
o DetachWithHSE
public virtual HRESULT DetachWithHSE(CATILinkableObject_var& iObject) = 0
Detach a given Object from this ModificationEffectivity: it is no more pointed out in "+" or in "-" by the ModificationEffectivity.
Parameters:
iObject
The Object to detach.
o Duplicate
public virtual HRESULT Duplicate( const CATIConfigurableObject_var& iCfgAble,
CATICfgModification_var& oEff) = 0
Duplicate this ModificationEffectivity: the copy is owned by an input ConfigurableObject.
Parameters:
iCfgAble
The input ConfigurableObject owning the copied ModificationEffectivity.
oEff
ModificationEffectivity to copy.
o GetAllHistories
public virtual HRESULT GetAllHistories(CATListValCATICfgHistory_var& oList,
const CATUnicodeString& iAttributeToSort= NULL) = 0
Return all Histories for this ModificationEffectivity.
Parameters:
oList
List of Histories to return.
o GetAttachedObjectsExtension
public virtual HRESULT GetAttachedObjectsExtension(SEQUENCE(CORBAAny)& oAttached) = 0
Return the List of Objects attached in "r" to this ModificationEffectivity.
Parameters:
oAttached
List of the Objects attached in "r".
o GetAttachedObjectsMinus
public virtual HRESULT GetAttachedObjectsMinus(SEQUENCE(CORBAAny)& oAttached) = 0
Return the List of Objects attached in "-" to this ModificationEffectivity.
Parameters:
oAttached
List of the Objects attached in "-".
o GetAttachedObjectsPlus
public virtual HRESULT GetAttachedObjectsPlus(SEQUENCE(CORBAAny)& oAttached) = 0
Return the List of Objects attached in "+" to this ModificationEffectivity.
Parameters:
oAttached
List of the Objects attached in "+".
o GetConfigurableObject
public virtual HRESULT GetConfigurableObject(CATIConfigurableObject_var& oCfgableObject) = 0
Return the ConfigurableObject owning this ModificationEffectivity.
Parameters:
oCfgableObject
ConfigurableObject to return.
o GetGroupMod
public virtual HRESULT GetGroupMod(CATICfgGroupModif_var& oGroupMod) = 0
Returns the Group Modification associated to the Modification.
Parameters:
oGroupMod
The Group Modificaion Effectivity which is common to this Modification
Returns:
  • S_OK if the method execution was successful.
  • E_FAIL if the method failedl.
  • S_FALSE if there is no Group Mod associated to this Modification
o GetListOfAttachedObjects
public virtual HRESULT GetListOfAttachedObjects(SEQUENCE(CORBAAny)& oAttached) = 0
Return the List of all the Objects attached in "+" or in "-" to this ModificationEffectivity.
Parameters:
oAttached
List of the attached Objects.
o GetModState
public virtual HRESULT GetModState(CATICfgModification::ModState& oModState) const = 0
Return the State of the ModificationEffectivity.
Parameters:
oModState
State of the ModificationEffectivity.
legal values: Normal, Canceled, Superseded, Penetration.
o GetName
public virtual HRESULT GetName(CATUnicodeString& oName) const = 0
Return the Name of the ModificationEffectivity.
Parameters:
oName
The ModificationEffectivity Name.
o GetParent
public virtual HRESULT GetParent(CATICfgModification_var& oParent) = 0
Return this modification's parent.
Parameters:
oParent
The parent of this modification.
o GetSuperseded
public virtual HRESULT GetSuperseded(CATListValCATICfgModification_var& oListMod) const = 0
Retrieve the List of ModificationEffectivities superseded by this ModificationEffectivity.
Parameters:
oListMod
List of ModificationEffectivities superseded: the method does not clean oListMod, it allows you to reuse oListMod in multiple call to GetSuperseded.
o GetX_Eff
public virtual HRESULT GetX_Eff( const CATUnicodeString& iDomainName,
CATICfgORExpression_var& oOrExp) = 0
Return the Effectivity (as an ORExression) associated to this ModificationEffectivity, given its DomainName.
Parameters:
iDomainName
Input DomainName of the Effectivity.
oOrExp
Effectivity to return.
o GetX_EffList
public virtual HRESULT GetX_EffList(CATListOfCATUnicodeString& oDomainList,
CATListValCATICfgORExpression_var& oOrExpList,
int iComputeCommonCondition= 0) = 0
Return the List of Effectivities (as ORExpressions) associated to this ModificationEffectivity.
Parameters:
oDomainList
DomainName List of the Effectivities.
oOrExpList
List of Effectivities.
o IsAttachedMinus
public virtual HRESULT IsAttachedMinus( const SEQUENCE(octet)& iUuid) = 0
Check if a given UUID-Object is attached in "-" to this ModificationEffectivity.
Legal values: The method returns S_OK if the Object is attached in "-", S_FALSE else.
Parameters:
iUuid
UUID of the input Object.
o IsAttachedPlus
public virtual HRESULT IsAttachedPlus( const SEQUENCE(octet)& iUuid) = 0
Check if a given UUID-Object is attached in "+" to this ModificationEffectivity.
Legal values: The method returns S_OK if the Object is attached in "+", S_FALSE else.
Parameters:
iUuid
UUID of the input Object.
o Modify
public virtual HRESULT Modify( const CATICfgModification::Operation iOp,
const CATILinkableObject_var& iObj1,
const CATILinkableObject_var& iObj2,
const int& iCheckSessionEffectivity= 0) = 0
Use this ModificationEffectivity to execute an operation on UUID-Objects.
Parameters:
iObj1
Object1.
iObj2
Object2.
iOp
Operation to execute.
Legal values: Add or Cut iObj1, Move or Replace iObj1 by iObj2.
iCV
CV to be set for secondary CV on history.
o Modify
public virtual HRESULT Modify( const CATICfgModification::Operation iOp,
const SEQUENCE(octet)& iObj1,
const SEQUENCE(octet)& iObj2= NULL,
const int& iCheckSessionEffectivity= 0) = 0
Use this ModificationEffectivity to execute an operation on UUID-Objects.
Parameters:
iObj1
UUID-Object1.
iObj2
UUID-Object2.
iOp
Operation to execute.
Legal values: Add or Cut iObj1, Move or Replace iObj1 by iObj2.
iCV
CV to be set for secondary CV on history.
o PointsTo
public virtual HRESULT PointsTo( const CATILinkableObject_var& iObj,
int& oPointed) const = 0
To find out if this modification points to an object
Parameters:
iObj
Object to analyze
oPointed
0 : do not point 1 : points + 2 : points - 3 : points + and -
o RemoveX_Eff
public virtual HRESULT RemoveX_Eff( const CATUnicodeString& iDomainName) = 0
Remove an Effectivity, given its DomainName, from this ModificationEffectivity.
Parameters:
iDomainName
DomainName of the Effectivity to remove.
o RemoveX_Effectivity
public virtual HRESULT RemoveX_Effectivity( const CATUnicodeString& iDomain) = 0
Remove an Effectivity from this ModificationEffectivity for a given DomainName.
Parameters:
iDomain
The DomainName of the Effectivity to remove.
o ResetParent
public virtual HRESULT ResetParent()= 0
Break the link between this modification and its parent.
o SetName
public virtual HRESULT SetName( const CATUnicodeString& iName) = 0
Set the name of this modification.
Parameters:
iName
The name to set to this modification.
Returns:
HRESULT S_OK = succeeded E_FAIL = failed (given name may already exist)
o SetParent
public virtual HRESULT SetParent( const CATICfgModification_var& iParent) = 0
Link this modification to another one to create a parent-child relationship.
Parameters:
iParent
The modification which will be the parent of this modification.
o SetVisible
public virtual HRESULT SetVisible( const CATBoolean iVisible) = 0
Set visibility of this modification (which is invisibble by default).
Parameters:
iVisible
TRUE if visible, FALSE if not.
o SetX_Eff
public virtual HRESULT SetX_Eff( const CATUnicodeString& iDomainName,
const CATICfgORExpression_var& iOrExp) = 0
Set an Effectivity (as an ORExpression) to this ModificationEffectivity.
Parameters:
iDomainName
DomainName of the Effectivity.
iOrExp
Effectivity to set.
o SetX_Effectivity
public virtual HRESULT SetX_Effectivity( const CATUnicodeString& iDomain,
const CATICfgEffectivity_var& iEffectivities) = 0
Set an Effectivity to this ModificationEffectivity for a given DomainName.
Parameters:
iDomain
The DomainName of the Effectivity to set.
iEffectivities
The Effectivity to set.
o Supersede
public virtual HRESULT Supersede( const CATListValCATICfgModification_var& iListMod) = 0
This ModificationEffectivity supersedes an input List of ModificationEffectivities: to be used when you cannot update the Effecivity of the ModificationEffectivities in iListMod.
Postcondition: All the Objects pointed in "+" or "-" by the ModificationEffectivities of the given input List are now aggregated by this ModificationEffectivity.
Parameters:
iListMod
The input List of ModificationEffectivities.
o UpdateEffectivity
public virtual HRESULT UpdateEffectivity()= 0
Update effectivities of all objects where this modification is involved.

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

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