All Frameworks Class Hierarchy This Framework Indexes Previous Next

PLMDictionaryNavServices CATCkePLMNavPublicServices

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

public class CATCkePLMNavPublicServices

Services enabling the access to PLM types and PLM attributes defined on PLM types or available on PLM Objects.

Small introduction to the different kinds of PLM types.
- top modeler types: for instance VPMReference. It corresponds to types delivered by our software out of the box
- discipline types: for instance Drawing. They correspond to sub types of top modeler types for a given application.
- custo types: it is the types defined by the customers with DMC tool, in Former typing system.
- specialization types: it is the types defined by the customers with the new KWD tool. They are different from custo types.
- extension types: An extension is put on an object by an application to extend its data model and its behaviors.
- specialization extension types: it correspond to a sub type of an extension defined by the customer with the new KWD tool.
- customer extension types: they correspond to an extension defined by a customer with the new KWD tool.
- deployment extension types: they are not available in CAA public APIs. A deployment extension is put on an object with a business rule to extend automatically its data model. Deployment extension are created with the DMA tool.
A PLM object has a primary type (modeler, discipline, specialization, custo) and potentially several secondary types (extension, and deployment extensions).
The services of this CATCkePLMNavPublicServices header are aimed at retrieving out of the box types only (modeler and discipline).
If you want to retrieve specialization types, please use .
If you want to retrieve custo types, please use .
The services of this CATCkePLMNavPublicServices header are also aimed at listing attributes on types at the exception of custo types.
If you want to list attributes on any types, including custo types, please use .
The services of this CATCkePLMNavPublicServices header are finally aimed at listing attributes on objects.
If you want to read attributes on an object, please use If you want to write attributes on an object, please use

See also:: , , , , , ,

Method Index

o FindAttributeFromObject(CATCkePLMTypeAttrServices::FilteringCriteria,CATICkeObject_var&,CATUnicodeString&,CATAttributeInfos*&,CATBoolean): Retrieves if it exists, a PLM attribute of a given name, on a PLM object that matches the criteria in input.
o FindAttributeFromType(CATCkePLMTypeAttrServices::FilteringCriteria,CATIType_var&,CATUnicodeString&,CATAttributeInfos*&,CATBoolean): Retrieves if it exists, a PLM attribute of a given name, of a PLM Type that matches the criteria in input.
o GetAttributeNLSNameFromType(CATIType_var&,CATIAdpEnvironment*,CATUnicodeString&,CATUnicodeString&): This service is used to translate in the current language the name of a PLM attribute of a given PLM type.
o GetCreationDateAttributeName(CATIType_var&): Service to retrieve the name of the CreationDate attribute for a given type.
o GetCreationDateAttributeNameFromObject(CATICkeObject_var&): Service to retrieve the name of the CreationDate attribute for a given object.
o GetMajorRevisionAttributeName(CATIType_var&): Service to retrieve the name of the major revision attribute for a given type.
o GetMajorRevisionAttributeNameFromObject(CATICkeObject_var&): Service to retrieve the name of the major revision attribute for a given object.
o GetMaturityAttributeName(CATIType_var&): Service to retrieve the name of the maturity attribute for a given type.
o GetMaturityAttributeNameFromObject(CATICkeObject_var&): Service to retrieve the name of the maturity attribute for a given object.
o GetModificationAttributeName(CATIType_var&): Service to retrieve the name of the Modification attribute for a given type.
o GetModificationAttributeNameFromObject(CATICkeObject_var&): Service to retrieve the name of the Modification attribute for a given object.
o GetOrganizationAttributeName(CATIType_var&): Service to retrieve the name of the organization attribute for a given type.
o GetOrganizationAttributeNameFromObject(CATICkeObject_var&): Service to retrieve the name of the organization attribute for a given object.
o GetOwnerAttributeName(CATIType_var&): Service to retrieve the name of the owner attribute for a given type.
o GetOwnerAttributeNameFromObject(CATICkeObject_var&): Service to retrieve the name of the owner attribute for a given object.
o GetProjectAttributeName(CATIType_var&): Service to retrieve the name of the project attribute for a given type.
o GetProjectAttributeNameFromObject(CATICkeObject_var&): Service to retrieve the name of the project attribute for a given object.
o GetReservedAttributeName(CATIType_var&): Service to retrieve the name of the Reserved attribute for a given type.
o GetReservedAttributeNameFromObject(CATICkeObject_var&): Service to retrieve the name of the Reserved attribute for a given object.
o GetReservedAttributeType(CATIType_var&): Service to retrieve the type of the Reserved attribute for a given type.
o GetReservedByAttributeName(CATIType_var&): Service to retrieve the name of the ReservedBy attribute for a given type.
o GetReservedByAttributeNameFromObject(CATICkeObject_var&): Service to retrieve the name of the ReservedBy attribute for a given object.
o GetRevisionAttributeName(CATIType_var&): Service to retrieve the name of the revision attribute for a given type.
o GetRevisionAttributeNameFromObject(CATICkeObject_var&): Service to retrieve the name of the revision attribute for a given object.
o IsAPrimaryType(CATIType_var&,CATBoolean&): Indicates if the type is a primary type or a secondary (extension)
o ListAttributesFromObject(CATCkePLMTypeAttrServices::FilteringCriteria,CATICkeObject_var&,CATListValCATAttributeInfos&,CATBoolean): This service is used to get the list of PLM attributes from a PLM object filtered by a criteria.
o ListAttributesFromPLMIdentificator(CATCkePLMTypeAttrServices::FilteringCriteria,CATIAdpPLMIdentificator_var&,CATListValCATAttributeInfos&,CATBoolean,CATBoolean): This service is used to get the list of PLM attributes of a PLM object from its PLM identificator filtered by a criteria.
o ListAttributesFromType(CATCkePLMTypeAttrServices::FilteringCriteria,CATIType_var&,CATIAdpEnvironment*,CATListValCATAttributeInfos&,CATBoolean): This service is used to get the list of PLM attributes of a PLM type filtered by a criteria.
o ListAutomaticDeploymentExtensions(CATIType_var&,CATListValCATIType_var&): Some deployment extensions can be defined as automatically associated to the type they extend.
o ListFilteredAttributesFromMaskAndObject(CATICkeObject_var&,CATCkePLMTypeAttrServices::PLMMaskCriteria,CATListValCATAttributeInfos&): Retrieves the list of PLM attributes of a PLM object that matches the PLM Mask criteria in input.
o ListFilteredAttributesFromMaskAndPLMIdentificator(CATIAdpPLMIdentificator_var&,CATCkePLMTypeAttrServices::PLMMaskCriteria,CATListValCATAttributeInfos&): Retrieves the list of attributes of a PLM Component from its identificator that matches the PLM Mask criteria in input.
o ListFilteredAttributesFromMaskAndType(CATIType_var&,CATIAdpEnvironment*,CATCkePLMTypeAttrServices::PLMMaskCriteria,CATListValCATAttributeInfos&): Retrieves the list of PLM attributes of a PLM type that matches the PLM Mask criteria in input.
o ListFilteredSecondaryAttributesFromMaskAndObject(CATICkeObject_var&,CATIType_var&,CATCkePLMTypeAttrServices::PLMMaskCriteria,CATListValCATAttributeInfos&): Retrieves the list of attributes of an object for a given Extension that matches the PLM Mask criteria in input.
o ListSecondaryAttributesFromObject(CATCkePLMTypeAttrServices::FilteringCriteria,CATICkeObject_var&,CATIType_var&,CATListValCATAttributeInfos&,CATBoolean): This service is used to get the list of attributes of an object for a given extension filtered by a criteria.
o RetrieveBasicAttributeNameFromPreviousOne(CATIType_var&,CATUnicodeString&): Service to translate the new names of basic attributes from their previous names.
o RetrieveBasicAttributeNameFromPreviousOneOnObject(CATICkeObject_var&,CATUnicodeString&): Service to translate the new names of basic attributes from their previous names, on an object.
o RetrieveKnowledgeType(char*,CATIType_var&): Returns the Knowledge type interface of a PLM type from a PLM type name.

Methods

o FindAttributeFromObject

public static FindAttributeFromObject(	const	`iFilteringCriteria`,
	const	`iObject`,
	const	`iAttributeName`,
		`opAttr`,
		`iReadWriteOnly`	`= FALSE`)

Retrieves if it exists, a PLM attribute of a given name, on a PLM object that matches the criteria in input.
With this method you can access the attributes of the primary type of the object and the attributes of the deployment extension if any.
However, this service do not list all the attributes of an object. It doesn't take into account the attribute of other extensions than the deployment extension.

Parameters:

iFilteringCriteria

Filtering criteria to apply

iObject

The object

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

TRUE if we want to obtain a list of the Read/Write attributes only.
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:

E_INVALIDARG if the input PLM object is invalid
S_OK if calculation is ok, even if the attribute is not found (= NULL)

o FindAttributeFromType

public static FindAttributeFromType(	const	`iFilteringCriteria`,
	const	`iType`,
	const	`iAttributeName`,
		`opAttr`,
		`iReadWriteOnly`	`= FALSE`)

Retrieves if it exists, a PLM attribute of a given name, of a PLM Type that matches the criteria in input.
This method is introduced as a replacement of CATCkePLMTypeAttrServices::FindAttribute.
This method works on primary types except custo types. It works on secondary types.
Use if you're interested in finding an attribute that you've created with DMC. Or finding an attribute whatever type
If you're interested to find the attribute from the PLM object, we recommend that you use instead.

Parameters:

iFilteringCriteria

Filtering criteria to apply. Note that the Identifier criteria does not make sense on a type so it will return an error if you use it.
Note also that the notion of mandatory/optional is disappearing at model level. It will make sense only when introduced by masks.
So the only filter that makes sense is All !

iType

The input PLM Type to be queried. It can be a modeler type, discipline type or specialization type. No custo type allowed.

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

TRUE if we want to obtain a list of the Read/Write attributes only.
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:

E_INVALIDARG if the input PLM type is NULL or if it is a custo type
S_OK if calculation is ok, even if the attribute is not found (= NULL)

o GetAttributeNLSNameFromType

public static GetAttributeNLSNameFromType(	const	`iType`,
	const	`ipiEnv`,
	const	`iAttributeName`,
		`oNLSName`)

This service is used to translate in the current language the name of a PLM attribute of a given PLM type.
If you're interested in accessing this information on a given object, please use instead

Parameters:

iType: Type in input. Modeler, Discipline or even specialization type. It cannot be a custo type but it can be a secondary type Use CATCkePLMNavCustoAccessPublicServices::GetAttributeNLSNameFromCustoType if you want to translate an attribute that you have defined with DMC. Or if you want to translate whatever the kind of type
ipiEnv: Useless
iAttributeName: Name of the attribute in the Knowledge dictionary (internal name)
oNLSName: NLS Name of the attribute

Returns:

E_INVALIDARG if the type is NULL, or if the type is a custo type.
S_OK if the attribute has been found
E_FAIL if not found

o GetCreationDateAttributeName

public static GetCreationDateAttributeName( const iType)

Service to retrieve the name of the CreationDate attribute for a given type.

Parameters:

iType: Type

Returns:

Name of the attribute. It returns the VPLM corresponding attribute if type was NULL.

o GetCreationDateAttributeNameFromObject

public static GetCreationDateAttributeNameFromObject( const iObject)

Service to retrieve the name of the CreationDate attribute for a given object.

Parameters:

iObject: Object

Returns:

Name of the attribute. It returns the VPLM corresponding attribute if object was NULL.

o GetMajorRevisionAttributeName

public static GetMajorRevisionAttributeName( const iType)

Service to retrieve the name of the major revision attribute for a given type.

Parameters:

iType: Type

Returns:

Name of the attribute. It returns the VPLM corresponding attribute if type was NULL.

o GetMajorRevisionAttributeNameFromObject

public static GetMajorRevisionAttributeNameFromObject( const iObject)

Service to retrieve the name of the major revision attribute for a given object.

Parameters:

iObject: Object

Returns:

Name of the attribute. It returns the VPLM corresponding attribute if object was NULL.

o GetMaturityAttributeName

public static GetMaturityAttributeName( const iType)

Service to retrieve the name of the maturity attribute for a given type.

Parameters:

iType: Type

Returns:

Name of the attribute. It returns the VPLM corresponding attribute if type was NULL.

o GetMaturityAttributeNameFromObject

public static GetMaturityAttributeNameFromObject( const iObject)

Service to retrieve the name of the maturity attribute for a given object.

Parameters:

iObject: Object

Returns:

Name of the attribute. It returns the VPLM corresponding attribute if object was NULL.

o GetModificationAttributeName

public static GetModificationAttributeName( const iType)

Service to retrieve the name of the Modification attribute for a given type.

Parameters:

iType: Type

Returns:

Name of the attribute. It returns the VPLM corresponding attribute if type was NULL.

o GetModificationAttributeNameFromObject

public static GetModificationAttributeNameFromObject( const iObject)

Service to retrieve the name of the Modification attribute for a given object.

Parameters:

iObject: Object

Returns:

Name of the attribute. It returns the VPLM corresponding attribute if object was NULL.

o GetOrganizationAttributeName

public static GetOrganizationAttributeName( const iType)

Service to retrieve the name of the organization attribute for a given type.

Parameters:

iType: Type

Returns:

Name of the attribute. It returns the VPLM corresponding attribute if type was NULL.

o GetOrganizationAttributeNameFromObject

public static GetOrganizationAttributeNameFromObject( const iObject)

Service to retrieve the name of the organization attribute for a given object.

Parameters:

iObject: Object

Returns:

Name of the attribute. It returns the VPLM corresponding attribute if object was NULL.

o GetOwnerAttributeName

public static GetOwnerAttributeName( const iType)

Service to retrieve the name of the owner attribute for a given type.

Parameters:

iType: Type

Returns:

Name of the attribute. It returns the VPLM corresponding attribute if type was NULL.

o GetOwnerAttributeNameFromObject

public static GetOwnerAttributeNameFromObject( const iObject)

Service to retrieve the name of the owner attribute for a given object.

Parameters:

iObject: Object

Returns:

Name of the attribute. It returns the VPLM corresponding attribute if object was NULL.

o GetProjectAttributeName

public static GetProjectAttributeName( const iType)

Service to retrieve the name of the project attribute for a given type.

Parameters:

iType: Type

Returns:

Name of the attribute. It returns the VPLM corresponding attribute if type was NULL.

o GetProjectAttributeNameFromObject

public static GetProjectAttributeNameFromObject( const iObject)

Service to retrieve the name of the project attribute for a given object.

Parameters:

iObject: Object

Returns:

Name of the attribute. It returns the VPLM corresponding attribute if object was NULL.

o GetReservedAttributeName

public static GetReservedAttributeName( const iType)

Service to retrieve the name of the Reserved attribute for a given type.

Parameters:

iType: Type

Returns:

Name of the attribute. It returns the VPLM corresponding attribute if type was NULL.

o GetReservedAttributeNameFromObject

public static GetReservedAttributeNameFromObject( const iObject)

Service to retrieve the name of the Reserved attribute for a given object.

Parameters:

iObject: Object

Returns:

Name of the attribute. It returns the VPLM corresponding attribute if object was NULL.

o GetReservedAttributeType

public static GetReservedAttributeType( const iType)

Service to retrieve the type of the Reserved attribute for a given type. It can be a boolean or a string (with value "Y" and "N")

Parameters:

iType: Type

Returns:

Type of the attribute. It returns the VPLM corresponding type if type was NULL.

o GetReservedByAttributeName

public static GetReservedByAttributeName( const iType)

Service to retrieve the name of the ReservedBy attribute for a given type.

Parameters:

iType: Type

Returns:

Name of the attribute. It returns the VPLM corresponding attribute if type was NULL.

o GetReservedByAttributeNameFromObject

public static GetReservedByAttributeNameFromObject( const iObject)

Service to retrieve the name of the ReservedBy attribute for a given object.

Parameters:

iObject: Object

Returns:

Name of the attribute. It returns the VPLM corresponding attribute if object was NULL.

o GetRevisionAttributeName

public static GetRevisionAttributeName( const iType)

Service to retrieve the name of the revision attribute for a given type. watch out: this service is returning Major revision on VPLM objects and revision on other we recommend to avoid using this service. Please use GetMajorRevisionAttributeName instead, or simply "revision"

Parameters:

iType: Type

Returns:

Name of the attribute. It returns the VPLM corresponding attribute if type was NULL.

o GetRevisionAttributeNameFromObject

public static GetRevisionAttributeNameFromObject( const iObject)

Service to retrieve the name of the revision attribute for a given object. watch out: this service is returning Major revision on VPLM objects and revision on other we recommend to avoid using this service. Please use GetMajorRevisionAttributeNameFromObject instead, or simply "revision"

Parameters:

iObject: Object

Returns:

Name of the attribute. It returns the VPLM corresponding attribute if object was NULL.

o IsAPrimaryType

public static IsAPrimaryType(	const	`iType`,
		`oPrimary`)

Indicates if the type is a primary type or a secondary (extension)

Parameters:

iType: The type in input
oPrimary: TRUE if primary, FALSE if secondary

Returns:

E_INVALIDARG if the type is NULL
S_OK

o ListAttributesFromObject

public static ListAttributesFromObject(	const	`iFilteringCriteria`,
	const	`iObject`,
		`oListAttr`,
		`iReadWriteOnly`	`= FALSE`)

This service is used to get the list of PLM attributes from a PLM object filtered by a criteria.
The attributes are the one of the primary type of the object (modeler type or discipline type or specialization type or custo type) in addition with the attributes of the deployment extension if there is one on the object.
However, this service do not list all the attributes of an object. It doesn't take into account the attribute of other extensions than the deployment extension.
This method is introduced as a replacement of that is now deprecated.
This method is usually used on an object to access its PLM public attributes from a modeler/application perspective. In UI layer, one should use ListFilteredAttributesFromMaskAndObject method.

Parameters:

iFilteringCriteria

Filtering criteria to apply

iObject

The object

oListAttr

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

iReadWriteOnly

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

TRUE if we want to obtain a list of the Read/Write attributes only.
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:

E_INVALIDARG if the input PLM Object is NULL
S_OK if the list of attributes is valuated (even if empty)
E_FAIL if failure

o ListAttributesFromPLMIdentificator

public static ListAttributesFromPLMIdentificator(	const	`iFilteringCriteria`,
	const	`iPLMIdentificator`,
		`oListAttr`,
		`iReadWriteOnly`	`= FALSE`,
		`iInverseOrder`	`= FALSE`)

This service is used to get the list of PLM attributes of a PLM object from its PLM identificator filtered by a criteria.
The attributes are the one of the primary type of the object (modeler type or discipline type or specialization type or custo type).
This method is introduced as a replacement of which is now deprecated.
Contrary to the previous method, this method does not include the attributes coming from the deployment extension.
This method is usually used on an object to access its PLM public attributes from a modeler/application perspective. In UI layer, one should use ListFilteredAttributesFromMaskAndObject method.

Parameters:

iFilteringCriteria

Filtering criteria to apply

iPLMIdentificator

The identificator of the PLM Component

oListAttr

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

iReadWriteOnly

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

iInverseOrder

Do not use. Order of attributes is not ensured

TRUE if we want to obtain a list of the Read/Write attributes only.
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:

E_INVALIDARG if the input PLM Object is NULL
S_OK if the list of attributes is valuated (even if empty)
E_FAIL if failure

o ListAttributesFromType

public static ListAttributesFromType(	const	`iFilteringCriteria`,
	const	`iType`,
	const	`ipiEnv`,
		`oListAttr`,
		`iReadWriteOnly`	`= FALSE`)

This service is used to get the list of PLM attributes of a PLM type filtered by a criteria.
The type in input can be a modeler type, or a discipline type (if any) or a specialization type.
It can also be an extension type.
It cannot be a custo type.
Use if you want to list attributes of a custo type that you have defined with DMC or if you want to list attributes for any kind of types.
If you're interested in the list of attributes on a particular object we recommend strongly that you use instead. This method is introduced as an alternative to that is now deprecated.

Parameters:

iFilteringCriteria

iType

The primary Knowledge type. No custo type accepted

ipiEnv

Useless

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

TRUE if we want to obtain a list of the Read/Write attributes only.
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:

E_INVALIDARG if the input PLM type is NULL or environment is NULL, or if the type is a custo type.
S_OK if the list of attributes is valuated (even if empty)
E_FAIL otherwise

o ListAutomaticDeploymentExtensions

public static ListAutomaticDeploymentExtensions(	const	`iType`,
		`oListOfAutomaticDeploymentExtensionTypes`)

Some deployment extensions can be defined as automatically associated to the type they extend.
In this context, it is natural to consider that each object of this type will have also all the attributes that are hold by the set of deployment extensions.
This service enables to retrieve the list of extensions automatically assigned to a type
It is done for advanced search.

Parameters:

iType: Type that is potentially extended
oListOfAutomaticDeploymentExtensionTypes: List of the extensions types associated to this type

Returns:

E_INVALIDARG if the input type is NULL
S_OK even if there is no deployment extensions

o ListFilteredAttributesFromMaskAndObject

public static ListFilteredAttributesFromMaskAndObject(	const	`iObject`,
	const	`iPLMMaskCriteria`,
		`oListFilteredAttr`)

Retrieves the list of PLM attributes of a PLM object that matches the PLM Mask criteria in input.
The attributes are the one of the primary type of the object (modeler type, discipline or functional specialization or custo type) in addition with the attributes of the deployment extension if there is one on the object.
However, this service do not list all the attributes of an object. It doesn't take into account the attribute of other extensions than the deployment extension.
This method is introduced as a replacement of .
This method is usually used on an object to show the list of PLM public attributes in UI (Edit properties, PLM New, Dedicated applicative UI).

Parameters:

iObject: The object
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:

E_INVALIDARG if the input PLM Object is NULL
S_OK if the list of attributes is valuated (even if empty)
E_FAIL if failure

o ListFilteredAttributesFromMaskAndPLMIdentificator

public static ListFilteredAttributesFromMaskAndPLMIdentificator(	const	`iPLMIdentificator`,
	const	`iPLMMaskCriteria`,
		`oListFilteredAttr`)

Retrieves the list of attributes of a PLM Component from its identificator that matches the PLM Mask criteria in input.
The attributes are the one of the primary type of the object (modeler type, discipline or functional specialization or custo type) in addition with the attributes of the deployment extension if there is one on the object.
This method is introduced as a replacement of .
This method is usually used on an object to show the list of PLM public attributes in UI (Edit properties, PLM New, Dedicated applicative UI).
Contrary to the previous method, this method doesn't add the attributes of the deployment extension.

Parameters:

iPLMIdentificator: The identificator of the PLM Component
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:

E_INVALIDARG if the input PLM Object is NULL
S_OK if the list of attributes is valuated (even if empty)
E_FAIL if failure

o ListFilteredAttributesFromMaskAndType

public static ListFilteredAttributesFromMaskAndType(	const	`iType`,
	const	`ipiEnv`,
	const	`iPLMMaskCriteria`,
		`oListFilteredAttr`)

Retrieves the list of PLM attributes of a PLM type that matches the PLM Mask criteria in input.
The type can be a modeler type, or a discipline type (if any) or specialization type.
It cannot be a custo type but it can be a secondary type (customer extension, deployment extension, included)
Use if you want to list attributes filtered by mask on a custo type that you have defined with DMC. Or if you want to list attributes for any kind of type
If you're interested in the list of attributes on a particular object you must use instead of this method. This method makes sense mainly for the query mask or easy query mask.
For the others, it is recommended to use .

Parameters:

iType: The primary type of the object. No custo type accepted
ipiEnv: Useless
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:

E_INVALIDARG if the input PLM type is invalid, or if the type is a custo type.
E_FAIL if failure
S_OK if the list of attributes is valuated (even if empty)

o ListFilteredSecondaryAttributesFromMaskAndObject

public static ListFilteredSecondaryAttributesFromMaskAndObject(	const	`iObject`,
	const	`iSecondaryType`,
	const	`iPLMMaskCriteria`,
		`oListFilteredAttr`)

Retrieves the list of attributes of an object for a given Extension that matches the PLM Mask criteria in input.
The attributes are the one of the secondary type in input of the object (modeler type, discipline or functional specialization in the future) added with the deployment extension if any exist on the object.
This method is introduced as a replacement of CATCkePLMTypeAttrServices::ListFilteredAttributesFromMask.
This method is usually used on an object to show the list of PLM public attributes of a particular extension in UI (Edit properties, PLM New, Dedicated applicative UI).

Parameters:

iObject: The object
iSecondaryType: The secondary type of the object on which we want to list the attributes.
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:

E_INVALIDARG if the input PLM type is invalid (NULL or not a secondary type) or if the object is NULL
S_OK if the list of attributes is valuated (even if empty)
E_FAIL if failure

o ListSecondaryAttributesFromObject

public static ListSecondaryAttributesFromObject(	const	`iFilteringCriteria`,
	const	`iObject`,
	const	`iSecondaryType`,
		`oListAttr`,
		`iReadWriteOnly`	`= FALSE`)

This service is used to get the list of attributes of an object for a given extension filtered by a criteria.
The attributes are the one of the primary type of the object (modeler type or discipline or functional specialization in the future) added with the deployment extension if any exist on the object.
This method is introduced as a replacement of CATCkePLMTypeAttrServices::ListAttributes.
This method is usually used on an object to access its PLM public attributes from a modeler/application perspective. In UI layer, one should use ListFilteredAttributesFromMaskAndObject method.

Parameters:

iFilteringCriteria

Filtering criteria to apply

iObject

The object

iSecondaryType

The secondary type of the object on which we want to list the attributes.

oListAttr

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

iReadWriteOnly

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

TRUE if we want to obtain a list of the Read/Write attributes only.
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:

E_INVALIDARG if the input PLM type is invalid (NULL or not a secondary type) or if the object is NULL
S_OK if the list of attributes is valuated (even if empty)
E_FAIL if failure

o RetrieveBasicAttributeNameFromPreviousOne

public static RetrieveBasicAttributeNameFromPreviousOne(	const	`iType`,
	const	`iCurrentAttributeNameUsed`)

Service to translate the new names of basic attributes from their previous names. When you want to deal with the basic attributes (owner, project, organisation, revision, maturity, creation data, modification date,reserved, reserved by)
It is highly recommanded to use the previous methods to retrieve their name. This will secure your code because those attribute names are likely to change in the future.
As current code is using hard coded names (ex: V_user), we provide the following service to help transition from these names to the real name of the attribute, that will be different from the one that is hard coded.
To ease code migration, if a standard attribute is passed, the method will not fail and will return the same attribute.

Parameters:

iType: Type
iCurrentAttributeNameUsed: Name of the attribute that is used currently

Returns:

Name that you should use

o RetrieveBasicAttributeNameFromPreviousOneOnObject

public static RetrieveBasicAttributeNameFromPreviousOneOnObject(	const	`iObject`,
	const	`iCurrentAttributeNameUsed`)

Service to translate the new names of basic attributes from their previous names, on an object. When you want to deal with the basic attributes (owner, project, organisation, revision, maturity, creation data, modification date,reserved, reserved by)
It is highly recommanded to use the previous methods to retrieve their name. This will secure your code because those attribute names are likely to change in the future.
As current code is using hard coded names (ex: V_user), we provide the following service to help transition from these names to the real name of the attribute, that will be different from the one that is hard coded.
To ease code migration, if a standard attribute is passed, the method will not fail and will return the same attribute.

Parameters:

iObject: Object
iCurrentAttributeNameUsed: Name of the attribute that is used currently

Returns:

Name that you should use

o RetrieveKnowledgeType

public static RetrieveKnowledgeType(	const	`iTypeName`,
		`oType`)

Returns the Knowledge type interface of a PLM type from a PLM type name.
Usage: to retrieve a particular out of the box type from the name we have found in the documentation (modeler and discipline).
Use if you want to retrieve a custo type that you have defined with DMC.
Use if you want to retrieve a specialization type that you have defined with KWD.

Parameters:

iTypeName: The type name in input. No custo type authorized. No specialization type authorized
oType: the type found

Returns:

E_INVALIDARG if the type is not found or type name is a custo type or a specialization type.
S_OK if the type has been found

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

PLMDictionaryNavServices writeClassCharacteristic(); CATCkePLMNavPublicServices

Method Index

Methods

PLMDictionaryNavServices CATCkePLMNavPublicServices