All Frameworks Class Hierarchy This Framework Indexes Previous Next

PLMCustomLinkInterfaces Interface PLMICustomRelationship

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

interface PLMICustomRelationship

Interface to query attributes of a Custom Relationship and to load its source/target.

Role: This class is used to get/set various attributes to a Customer Relationship

Method Index

o GetDescription(CATUnicodeString&): Get the description (attribute V_description) of the current Custom Relationship.
o GetName(CATUnicodeString&): Get the name of the current Custom Relationship (RFLPLMAgnosticFreeConnection).
o GetOwner(CATIPLMComponent*&): Return the aggregating object (owner) of the current Custom Relationship.
o GetRelationTypeName(CATUnicodeString&): Get the relation type name (attribute V_RelationTypeName) of the current Custom Relationship.
o GetSourceObject(CATIPLMComponent*&): Return the source of the current Agnostic Relationship (RFLPLMAgnosticFreeConnection).
o GetTargetObject(CATIPLMComponent*&): Return the target of the current Custom Relationship (RFLPLMAgnosticFreeConnection).
o LoadsSourceObjectInSession(CATIPLMComponent*&): Loads explicitely the Source object is session if it is not yet.
o LoadsTargetObjectInSession(CATIPLMComponent*&): Loads explicitely the Target object is session if it is not yet.
o RerouteTargetObject(CATIPLMComponent*): Reroute the target of the current Custom Relationship (RFLPLMAgnosticFreeConnection).
o SetDescription(CATUnicodeString&): Set the description (attribute V_description) of the current Custom Relationship.
o SetName(CATUnicodeString&): Sets the name (attribute PLM_ExternalID) of the current Custom Relationship (RFLPLMAgnosticFreeConnection).
o SetRelationTypeName(CATUnicodeString&): Set the relation type name (attribute V_RelationTypeName) of the current Custom Relationship.

Methods

o GetDescription

public virtual GetDescription( oDescription)

Get the description (attribute V_description) of the current Custom Relationship.

Parameters:

oDescription: [out] The description of Custom Relationship object.

Returns:

S_OK the attribute is valuated S_FALSE the attribute is not valuated E_FAIL otherwise

o GetName

public virtual GetName( oName)

Get the name of the current Custom Relationship (RFLPLMAgnosticFreeConnection).

Parameters:

oName: [out] The name of the custom relationship.

Returns:

S_OK the attribute is valuated S_FALSE the attribute is not valuated E_FAIL otherwise

o GetOwner

public virtual GetOwner( opiAggregatingObject)

Return the aggregating object (owner) of the current Custom Relationship.

Parameters:

opiAggregatingObject: [out, CATBaseUnknown#Release] The returned aggregating object (owner)

Returns:

S_OK if everything succeeded. E_INVALIDARG if opiAggregatingObject is not null E_FAIL otherwise.

o GetRelationTypeName

public virtual GetRelationTypeName( oRelTypeName)

Get the relation type name (attribute V_RelationTypeName) of the current Custom Relationship.

Parameters:

oRelTypeName: [out] The relation type name of Custom Relationship object.

Returns:

S_OK the attribute is valuated S_FALSE the attribute is not valuated E_FAIL otherwise

o GetSourceObject

public virtual GetSourceObject( opiSourceObject)

Return the source of the current Agnostic Relationship (RFLPLMAgnosticFreeConnection).

Parameters:

opiSourceObject: [out, CATBaseUnknown#Release] The source object.

Returns:

S_OK if everything succeeded and a source object is returned.

o GetTargetObject

public virtual GetTargetObject( opiPLMCompOnTargetObject)

Return the target of the current Custom Relationship (RFLPLMAgnosticFreeConnection).

Parameters:

opiPLMCompOnTargetObject: [out, CATBaseUnknown#Release] The target object.
Can be NULL if the relation is broken.

Returns:

S_OK if everything succeeded and a source object is returned.

o LoadsSourceObjectInSession

public virtual LoadsSourceObjectInSession( opiPLMCompOnSourceObject)

Loads explicitely the Source object is session if it is not yet.

Parameters:

opiPLMCompOnSourceObject: [out, CATBaseUnknown#Release] The PLM object which is source of the current RFLP Custom Relationship and now loaded in session.

Returns:

S_OK if source is successfully loaded in session S_FALSE if the source is already in session E_INVALIDARG if opiSourceObject is not null E_ACCESSDENIED if source is deleted from session or db E_FAIL otherwise

o LoadsTargetObjectInSession

public virtual LoadsTargetObjectInSession( opiPLMCompOnTargetObject)

Loads explicitely the Target object is session if it is not yet.

Parameters:

opiPLMCompOnTargetObject: [out, CATBaseUnknown#Release] The PLM object which is Target of the current RFLP Custom Relationship and now loaded in session.

Returns:

S_OK if target is successfully loaded in session S_FALSE if the target is already in session E_INVALIDARG if opiTargetObject is not null E_ACCESSDENIED if target is deleted from session or db E_FAIL otherwise

o RerouteTargetObject

public virtual RerouteTargetObject( ipiNewTargetObject)

Reroute the target of the current Custom Relationship (RFLPLMAgnosticFreeConnection).

Parameters:

ipiNewTargetObject: [in] The new target object.

Returns:

S_OK if everything succeeded. E_INVALIDARG if piPLMCompOnNewTgtObj is null or new target same as existing one E_FAIL otherwise

o SetDescription

public virtual SetDescription( const iDescription)

Set the description (attribute V_description) of the current Custom Relationship.

Parameters:

iDescription: [in] The description to be applied to the current Custom Relationship object.

Returns:

S_OK the attribute is valuated E_INVALIDARG iDescription is empty E_FAIL otherwise

o SetName

public virtual SetName( const iName)

Sets the name (attribute PLM_ExternalID) of the current Custom Relationship (RFLPLMAgnosticFreeConnection).

Parameters:

iName: [in] The name to be applied to the current custom relationship.

Returns:

S_OK the attribute is valuated E_INVALIDARG iName is empty E_FAIL otherwise

o SetRelationTypeName

public virtual SetRelationTypeName( const iRelTypeName)

Set the relation type name (attribute V_RelationTypeName) of the current Custom Relationship.

Parameters:

iRelTypeName: [in] The relation type name to be applied to the current Custom Relationship object.

Returns:

S_OK the attribute is valuated E_INVALIDARG iRelTypeName is empty E_FAIL otherwise

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