All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ENOVInterfaces Interface ENOVIABORelation

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---System.CATBaseDispatch
        |
        +---System.CATIABase
          |
          +---ENOVInterfaces.ENOVIABusinessObject
            |
            +---ENOVIABORelation
 

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


interface ENOVIABORelation

Allows to control the Relation.
Role : A relation is a class which allow to make links between Business Objects. So a relation is pointing by some BO and the same relation is pointing others BO. Like this, a link is made between objects. BO1 ---- pointing ----> RELATION ---- pointed ----> BO2.


Method Index


o add_PointedObject(ENOVIABusinessObject*)
Makes the relation pointing to a new Business Object.
o add_PointingObject(ENOVIABusinessObject*)
Sets a relation to a Business Object.
o cut_PointedObject(ENOVIABusinessObject*)
Removes the relation with a pointed Business Object.
o cut_PointingObject(ENOVIABusinessObject*)
Removes the relation with a pointing Business Object.
o get_PointedObject(long,ENOVIABusinessObject*&)
Gets a specific BO pointed by the relation.
o get_PointedObjectCount(long&)
Gets the number of BO which are pointed by the relation.
o get_PointingObject(long,ENOVIABusinessObject*&)
Gets a specific BO pointing to the relation.
o get_PointingObjectCount(long&)
Gets the number of BO which are pointing to the relation.
o put_Owner(CATBaseUnknown*)
Sets the owner of a relation.

Methods


o add_PointedObject
public virtual HRESULT __stdcall add_PointedObject(ENOVIABusinessObject* iPointedBO)= 0
Makes the relation pointing to a new Business Object. The BO is pointed by the relation.
Parameters:
iPointedBO
specifies the BO to be pointed by the relation.
Returns:
S_OK in case of success, E_FAIL in case of error.
o add_PointingObject
public virtual HRESULT __stdcall add_PointingObject(ENOVIABusinessObject* iPointingBO)= 0
Sets a relation to a Business Object. The BO is pointing to the relation.
Parameters:
iPointingBO
specifies the BO from which we wish to point.
Returns:
S_OK in case of success, E_FAIL in case of error.
o cut_PointedObject
public virtual HRESULT __stdcall cut_PointedObject(ENOVIABusinessObject* iPointedBO)= 0
Removes the relation with a pointed Business Object. The BO is not pointed by the relation anymore.
Parameters:
iPointedBO
is the pointed BO from wish we wish to cut the relation.
Returns:
S_OK in case of success, E_FAIL in case of error.
o cut_PointingObject
public virtual HRESULT __stdcall cut_PointingObject(ENOVIABusinessObject* iPointingBO)= 0
Removes the relation with a pointing Business Object. The BO is not pointing to the relation anymore.
Parameters:
is
the pointing BO from which we wish to cut the relation.
Returns:
S_OK in case of success, E_FAIL in case of error.
o get_PointedObject
public virtual HRESULT __stdcall get_PointedObject(long iIndex,
ENOVIABusinessObject*& oPointedBO)= 0
Gets a specific BO pointed by the relation. This BO is specified by its index number.
Parameters:
iIndex
specifies the number of the pointed BO we wish to retreive.
oPointedBO
is the BO retreiving by the index value.
Returns:
S_OK in case of success, E_FAIL in case of error.
o get_PointedObjectCount
public virtual HRESULT __stdcall get_PointedObjectCount(long& oNbItems)= 0
Gets the number of BO which are pointed by the relation.
Parameters:
oNbItems
is the number of pointed objects by the relation.
Returns:
S_OK in case of success, E_FAIL in case of error.
o get_PointingObject
public virtual HRESULT __stdcall get_PointingObject(long iIndex,
ENOVIABusinessObject*& oPointingBO)= 0
Gets a specific BO pointing to the relation. This BO is specified by its index number.
Parameters:
iIndex
specifies the number of the pointing BO we wish to retreive.
oPointingBO
is the BO retreiving by the index value.
Returns:
S_OK in case of success, E_FAIL in case of error.
o get_PointingObjectCount
public virtual HRESULT __stdcall get_PointingObjectCount(long& oNbItems)= 0
Gets the number of BO which are pointing to the relation.
Parameters:
oNbItems
is the number of pointing objects by the relation.
Returns:
S_OK in case of success, E_FAIL in case of error.
o put_Owner
public virtual HRESULT __stdcall put_Owner(CATBaseUnknown* iOwner)= 0
Sets the owner of a relation.
Parameters:
iOwner
specifies the new owner of the relation.
Returns:
S_OK in case of success, E_FAIL in case of error.

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

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