All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

VPMInterfaces Interface CATIVpmAFLAffectedObject

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

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


interface CATIVpmAFLAffectedObject

Class to manage the Action Flow Affected Objects.
Role: Affected Objects are attached to Actions to control the items that are to be created/modified for the Action.


Method Index


o AddObject(CATIVpmAFLAffectedObject_var&,int)
Adds a pointed object to this Affected Object.
o CopyTo(CATIVpmAFLAffectedObject_var&)
Copies attributes from this Affected Object to another (customized attributes are copied if possible).
o Dump(char*)
Dumps the Affected Object attributes.
o GetActionRelated(CATIVpmAFLAction_var&)
Retrieves the Action handling this Affected Object.
o GetChangeType(CATUnicodeString&)
Get the change type.
o GetCreationDate(CATTime&)
Retrieves the creation date from this Affected Object.
o GetDesc(CATUnicodeString&)
Retrieves the description of this Affected Object.
o GetId(CORBAAny&)
Retrieves the Identifier of the object pointed to by the Affected Object (under a tk_binary sequence octet).
o GetId(SEQUENCE(octet)&)
Retrieves the identifier of the object pointed to by the Affected Object.
o GetLastModifDate(CATTime&)
Get the last modification date from this Affected Object.
o GetName(CATUnicodeString&)
Obsolete.
o GetPointedAffectedObjects(CATLISTV(CATIVpmAFLAffectedObject_var)&)
Retrieves a list of pointed Affected Objects for this Affected Object.
o GetPointingAffectedObjects(CATLISTV(CATIVpmAFLAffectedObject_var)&)
Retrieves a list of pointing Affected Objects for this Affected Object.
o GetPriority(CATUnicodeString&)
Retrieves the priority of this Affected Object.
o GetRealObject(CATIVpmFactoryObject_var&)
Retrieves the real object pointed to by the Affected Object.
o GetSource(CATUnicodeString&)
Retrieves the modeler source of this Affected Object.
o GetStatus(CATUnicodeString&)
Retrieves the status of this Affected Object.
o GetType(CATUnicodeString&)
Retrieves the type of Affected Object.
o GetUUID(SEQUENCE(octet)&)
Retrieves the UUID of an Affected Object.
o RemoveObject(CATIVpmAFLAffectedObject_var&)
Removes a pointed object from this Affected Object.
o SetChangeType(CATUnicodeString&)
Set the change type.
o SetDesc(CATUnicodeString&)
Assigns the description of this Affected Object.
o SetPriority(CATUnicodeString&)
Assigns the priority of this Affected Object.
o SetSource(CATUnicodeString&)
Assigns the modeler source of this Affected Object.

Methods


o AddObject
public virtual HRESULT AddObject(CATIVpmAFLAffectedObject_var& iObject,
const int isPersistent=0)=0
Adds a pointed object to this Affected Object. The add operation may be persistent or not depending on the persistency flag (second parameter).
Parameters:
iObject
The pointed object to be added.
isPersistent
Specify whether the add operation is persistent or not (default).
o CopyTo
public virtual HRESULT CopyTo(CATIVpmAFLAffectedObject_var& oObj)=0
Copies attributes from this Affected Object to another (customized attributes are copied if possible).
Parameters:
oObj
The target Affected Object.
o Dump
public virtual HRESULT Dump(char* iPrefix)=0
Dumps the Affected Object attributes.
Parameters:
iPrefix
The prefix text for each output line.
o GetActionRelated
public virtual HRESULT GetActionRelated(CATIVpmAFLAction_var& oActionRelated)=0
Retrieves the Action handling this Affected Object.
Parameters:
oActionRelated
The Action.
o GetChangeType
public virtual HRESULT GetChangeType(CATUnicodeString& oChgType)=0
Get the change type.
Parameters:
oChgType
o GetCreationDate
public virtual HRESULT GetCreationDate(CATTime& oTime)=0
Retrieves the creation date from this Affected Object.
Parameters:
oTime
The creation date.
o GetDesc
public virtual HRESULT GetDesc(CATUnicodeString& oObjDesc)=0
Retrieves the description of this Affected Object.
Parameters:
oObjDesc
The Affected Object description.
o GetId
public virtual HRESULT GetId(CORBAAny& oId)=0
Retrieves the Identifier of the object pointed to by the Affected Object (under a tk_binary sequence octet).
Parameters:
oId
The pointed object identifier.
o GetId
public virtual HRESULT GetId(SEQUENCE(octet)& oId)=0
Retrieves the identifier of the object pointed to by the Affected Object.
Parameters:
oId
The pointed object identifier.
o GetLastModifDate
public virtual HRESULT GetLastModifDate(CATTime& oTime)=0
Get the last modification date from this Affected Object.
Parameters:
oTime
The last modification date.
o GetName
public virtual HRESULT GetName(CATUnicodeString& oName)=0
Obsolete. Use the ENOVINamedObject interface instead.
Parameters:
oName
The Affected Object name.
o GetPointedAffectedObjects
public virtual HRESULT GetPointedAffectedObjects(CATLISTV(CATIVpmAFLAffectedObject_var)& oListObjects)=0
Retrieves a list of pointed Affected Objects for this Affected Object.
Parameters:
oListObjects
The list of pointed objects.
o GetPointingAffectedObjects
public virtual HRESULT GetPointingAffectedObjects(CATLISTV(CATIVpmAFLAffectedObject_var)& oListObjects)=0
Retrieves a list of pointing Affected Objects for this Affected Object.
Parameters:
oListObjects
The list of pointing objects.
o GetPriority
public virtual HRESULT GetPriority(CATUnicodeString& oObjPriority)=0
Retrieves the priority of this Affected Object.
Parameters:
oObjPriority
The Affected Object priority.
o GetRealObject
public virtual HRESULT GetRealObject(CATIVpmFactoryObject_var& oObj)=0
Retrieves the real object pointed to by the Affected Object.
Parameters:
oObj
The pointed object.
o GetSource
public virtual HRESULT GetSource(CATUnicodeString& oObjSource)=0
Retrieves the modeler source of this Affected Object.
Parameters:
oObjSource
The Affected Object modeler source.
o GetStatus
public virtual HRESULT GetStatus(CATUnicodeString& oObjStatus)=0
Retrieves the status of this Affected Object.
Parameters:
oObjStatus
The Affected Object status.
o GetType
public virtual HRESULT GetType(CATUnicodeString& oObjType)=0
Retrieves the type of Affected Object.
Parameters:
oObjType
The Affected Object type.
o GetUUID
public virtual HRESULT GetUUID(SEQUENCE(octet)& oUUID)=0
Retrieves the UUID of an Affected Object.
Parameters:
oUUID
The Affected Object identifier.
o RemoveObject
public virtual HRESULT RemoveObject(CATIVpmAFLAffectedObject_var& iObject)=0
Removes a pointed object from this Affected Object.
Parameters:
iObject
The pointed object to be removed.
o SetChangeType
public virtual HRESULT SetChangeType( const CATUnicodeString& iChgType)=0
Set the change type.
Parameters:
iChgType
o SetDesc
public virtual HRESULT SetDesc( const CATUnicodeString& iObjDesc)=0
Assigns the description of this Affected Object.
Parameters:
iObjDesc
The Affected Object description.
o SetPriority
public virtual HRESULT SetPriority( const CATUnicodeString& iObjPriority)=0
Assigns the priority of this Affected Object.
Parameters:
iObjPriority
The Affected Object priority.
o SetSource
public virtual HRESULT SetSource( const CATUnicodeString& iObjSource)=0
Assigns the modeler source of this Affected Object.
Parameters:
iObjSource
The Affected Object modeler source.

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

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