KnowledgeInterfaces CATCkePLMTypeAttrServices

Usage: you must use this class as is. You should never derive it.

public class CATCkePLMTypeAttrServices

Services to access lists of attributes of a PLM Type, filtered by PLM criteria (mandatory, optional, identifier).

deprecated: use CATCkePLMNavPublicServices instead. This class is used for the enum only Role: A PLM Type implements the interfaces & , that completely describe its attributes. This class simply provides additional services for filtering those attributes easily based on some criteria.

See also:

, ,

Method Index

o FindAttribute(CATCkePLMTypeAttrServices::FilteringCriteria,CATIType_var&,CATUnicodeString&,CATAttributeInfos*&,CATBoolean)

o ListAttributes(CATCkePLMTypeAttrServices::FilteringCriteria,CATIType_var&,CATListValCATAttributeInfos&,CATBoolean)

o ListFilteredAttributesFromMask(CATIType_var&,CATCkePLMTypeAttrServices::PLMMaskCriteria,CATListValCATAttributeInfos&)

Enumerated Type Index

o FilteringCriteria

Enumerated value that defines the possible criteria that we will use to filter the list of attributes.

o PLMMaskCriteria

Enumerated value that defines the possible PLM Mask that we will use to filter the list of attributes.

Methods

Deprecated:

R211 CATCkePLMNavPublicServices::FindAttributeFromType.
Retrieves if it exists, an attribute of a given name, of a PLM type that matches the criteria in input.

Parameters:

iFilteringCriteria

Filtering criteria to apply

iType

The input PLM type to be queried.

iAttributeName

The non-NLS name of the attribute.

opAttr

The attribute, if found. The service allocates the object, so the given pointer must be NULL, and must be deleted after use.

iReadWriteOnly

Specify if we want to apply an additional filter to access only Read/Write attributes

1. TRUE if we want to obtain a list of the Read/Write attributes only.
2. FALSE (default value) if we do not want to apply this additional filter, and we want to obtain both Read Only attributes and Read/Write.

Returns:

1. E_INVALIDARG if the input PLM type is invalid
2. S_OK if calculation is ok, even if the attribute is not found (= NULL)

Deprecated:

R211 CATCkePLMNavPublicServices::ListAttributesFromObject. Because you're likely to start from an object and not a type.
Retrieves the list of attributes of a PLM type that matches the criteria in input.

Parameters:

iFilteringCriteria

Filtering criteria to apply

iType

The input PLM type to be queried.

oListAttr

The list of PLM attributes obtained. It is filled by the service. The service removes elements of the list in input first.

iReadWriteOnly

Specify if we want to apply an additional filter to access only Read/Write attributes

1. TRUE if we want to obtain a list of the Read/Write attributes only.
2. FALSE (default value) if we do not want to apply this additional filter, and we want to obtain both Read Only attributes and Read/Write.

Returns:

1. E_INVALIDARG if the input PLM type is invalid
2. S_OK if the list of attributes is valuated (even if empty)

Deprecated:

R211 CATCkePLMNavPublicServices::ListFilteredAttributesFromMaskAndObject or ListFilteredAttributesFromMaskAndType. Retrieves the list of attributes of a PLM type that matches the PLM Mask criteria in input.

Parameters:

iKweType

The input type to be queried.

iPLMMaskCriteria

Filtering PLM Mask criteria to apply

oListFilteredAttr

The list of PLM attributes obtained. It is filled by the service. The service removes elements of the list in input first.

Returns:

1. E_INVALIDARG if the input PLM type is invalid
2. E_FAIL if failure
3. S_OK if the list of attributes is valuated (even if empty)

Enumerated Types