CATPLMComponentInterfaces Interface CATIPLMNavEntity

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

interface CATIPLMNavEntity

Interface to retrieve general information on an Entity.

Method Index

o GetPLMCoreType(CATPLMCoreType&): Retrieves the client core type of the Entity.
o GetPublicAttributes(CATListOfCATUnicodeString&,CATListOfCATUnicodeString&): Retrieves the values of a list of public attributes attached to the Entity.

Methods

o GetPLMCoreType

public virtual GetPLMCoreType( oType)

Retrieves the client core type of the Entity.

Parameters:

oType: The core type.

Returns:

HRESULT
Legal values:

S_OK: The type is successfully returned.
E_FAIL: The Entity is not valid or the state of the system is not correct for this operation.
E_UNEXPECTED: There is an unexpected failure.

o GetPublicAttributes

public virtual GetPublicAttributes(		`ioAttributeNameList`,
		`oAttributeValueList`)

Retrieves the values of a list of public attributes attached to the Entity. WARNING: this list is usable for information and display, not for attribute management.

Parameters:

ioAttributeNameList

The list of attributes' internal name.
Legal values:

Empty: All the public attributes names and values have to be returned.
Filled: Only the values of the attributes which name is in this list have to be returned. In this case the list is not modified.

oAttributeValueList

The list of attributes' value. It is is cleaned before treatment.
Legal values:

Filled: The list of values of required attributes. This list has the same size than the previous one.

Returns:

HRESULT
Legal values:

S_OK: The list (Empty or Filled) is successfully returned.
E_INVALIDARG: The given ioAttributeNameList contains the name of an invalid attribute.
E_FAIL: The Entity is not valid or the state of the system is not correct for this operation.
E_UNEXPECTED: There is an unexpected failure.

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