All Frameworks Class Hierarchy This Framework Indexes Previous Next

PLMCustomLinkInterfaces Interface PLMICustomRelationshipManager

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

interface PLMICustomRelationshipManager

Interface represents a factory to create and subsequently manage (operate on) a Custom Relationship.

Role: This class is used to create and manage a Custom Relationship in session

Method Index

o CreateCustomRelationship(CATIAdpEnvironment*,CATIPLMComponent*,CATIPLMComponent*,CATUnicodeString&,CATUnicodeString&,PLMICustomRelationship_var&): Creates an Custom Relationship between two specified objects.
o DeleteCustomRelationship(PLMICustomRelationship_var&): Deletes a given Custom Relationship.
o GetCustomRelationshipFromOwner(CATIPLMComponent*,CATListValPLMICustomRelationship_var&): Return all the Custom Relationship (RFLPLMCustomRelation) aggregated by the specified object.
o GetCustomRelationshipsFromSource(CATIPLMComponent*,CATListValPLMICustomRelationship_var&): Return all the Custom Relationship (RFLPLMCustomRelation) of which the specified object is the source.
o GetCustomRelationshipsFromTarget(CATIPLMComponent*,CATListValPLMICustomRelationship_var&): Return all the Custom Relationship (RFLPLMCustomRelation) of which the specified object is the target.

Methods

o CreateCustomRelationship

public virtual CreateCustomRelationship(		`ipiEnv`,
		`ipiSourceObject`,
		`ipiTargetObject`,
	const	`iName`,
	const	`iRelationTypeName`,
		`ospConnection`)

Creates an Custom Relationship between two specified objects.

Parameters:

ipiEnv: [in] The environment in which the Custom relationship has to be created.
ipiSourceObject: [in] The source object.
ipiTargetObject: [in] The target object.
iName: [in] The Name (attribute PLMExternal_ID) of the Custom relationship.
iRelationTypeName: [in] The Relation Type Name (attribute V_RelationTypeName) of the Custom relationship.
ospConnection: [out] The created RFLPLMAgnosticFreeConnection object.

Returns:

S_OK if the RFLPLMAgnosticFreeConnection has been created. E_INVALIDARG if the source or target types are not supported (not one of the RFLP Modeler types) E_FAIL otherwise.

o DeleteCustomRelationship

public virtual DeleteCustomRelationship( ispCustoRelToDelete)

Deletes a given Custom Relationship.

Parameters:

ispCustoRelToDelete: [in] The RFLPLMAgnosticFreeConnection object to be deleted.

Returns:

E_INVALIDARG if the input Custo Relationship is NULL S_OK if the RFLPLMAgnosticFreeConnection has been deleted. E_FAIL otherwise.

o GetCustomRelationshipFromOwner

public virtual GetCustomRelationshipFromOwner(		`ipAggregatingObject`,
		`oListOfCustomRelationships`)

Return all the Custom Relationship (RFLPLMCustomRelation) aggregated by the specified object.

Parameters:

ipAggregatingObject: [in] The object of which we want to retrieve the aggregated Custom Relationship (RFLPLMAgnosticFreeConnection).
oListOfCustomRelationships: [out] The returned list of Custom Relationship (RFLPLMAgnosticFreeConnection).

Returns:

S_OK if everything succeeded. S_FALSE if oListOfCustomRelationships is empty E_INVALIDARG if ipAggregatingObject is null, is not a PLM Ref or oListOfCustomRelationships not empty. E_FAIL otherwise.

o GetCustomRelationshipsFromSource

public virtual GetCustomRelationshipsFromSource(		`piPLMCompSourceObject`,
		`oListOfCustomRelationships`)

Return all the Custom Relationship (RFLPLMCustomRelation) of which the specified object is the source.
The list is empty if the specified object is not the source of any Custom Relationship.

Parameters:

piPLMCompSourceObject: [in] A PLM source object from which Custom Relationships are searched for.
oListOfCustomRelationships: [out] The returned list of Custom Relationship (RFLPLMAgnosticFreeConnection), empty if the object is not the source of any Custom Relationship.

Returns:

S_OK if everything succeeded. S_FALSE if oListOfCustomRelationships is empty E_INVALIDARG if piPLMCompSourceObject is null, oListOfCustomRelationships not empty, source not loaded in session or source is a PLM Rep Ref or a VO E_FAIL otherwise.

o GetCustomRelationshipsFromTarget

public virtual GetCustomRelationshipsFromTarget(		`piPLMCompOnTargetObject`,
		`oListOfCustomRelationships`)

Return all the Custom Relationship (RFLPLMCustomRelation) of which the specified object is the target.
The list is empty if the specified object is not the target of any Custom Relationship.

Parameters:

piPLMCompOnTargetObject: [in] A PLM target object from which Custom Relationships are searched for.
oListOfCustomRelationships: [out] The returned list of Custom Relationship (RFLPLMAgnosticFreeConnection), empty if the object is not the target of any Custom Relationship.

Returns:

S_OK if everything succeeded. S_FALSE if oListOfCustomRelationships is empty E_INVALIDARG if piPLMCompOnTargetObject is null, oListOfCustomRelationships not empty, target not loaded in session or target is a PLM Rep Ref or a VO E_FAIL otherwise.

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