All Frameworks Class Hierarchy This Framework Next Indexes
ENOVDDManager Class DDMNGUtil
DDMNGUtil
Usage: you must use this class as is. You should never derive it.
public class DDMNGUtil
Class that provides a set of services for Content Management objects.
Role: This class provides services to:
- Retrieve an object from its UUID
- Manage links between objects
- Retrieve the document format from the document master
- Retrieve the super type of a given type or all the ENOVIA types
- Create an history entry on given object
- Update the document file attributes from the vault document.
Method Index
- o
GetBasicType(CATUnicodeString&)
- Retrieves the object's super type from its type.
- o
GetListOfBasicType()
- Returns all the ENOVIA basic types.
- o
UUIDtoFOV(CORBAAny&,CATIVpmFactoryObject_var&)
- Retrieves an object from its UUID.
- o
UpdateFileAttributes(CATIAVPMObjectVersion_var&,ENOVIVaultDocument*&)
- Updates the document file attributes from the vault document.
- o
createLink(CATIVpmFactoryObject_var&,CATIVpmFactoryObject_var&,CATUnicodeString&)
- Creates a link between two objects.
- o
deleteLink(CATIVpmFactoryObject_var&,CATIVpmFactoryObject_var&,CATUnicodeString&)
- Deletes a link between two objects.
- o
getFormatFromMaster(CATIVpmFactoryObject_var&,CATIVpmFactoryObject_var&)
- Retrieves the document format from the document master.
- o
getReverseRelations(CATIVpmFactoryObject_var&,CATUnicodeString&,CATLISTV(CATIVpmFactoryObject_var)&)
- Retrieves the objects linked to a given anchor object using a given connector.
- o
logHistory(CATIVpmFactoryObject_var&,CATUnicodeString&,CATUnicodeString&)
- Creates an history entry on given object.
- o
retrieveLinks(CATIVpmFactoryObject_var&,CATLISTV(CATIVpmFactoryObject_var)&,CATUnicodeString&)
- Retrieves the objects linked to a given anchor object using a given connector.
Methods
o GetBasicType
-
Retrieves the object's super type from its type.
- Parameters:
-
- iType
- [in] The object's type
- Returns:
- The object's super type. If the object has no super type, its type is returned.
o GetListOfBasicType
-
Returns all the ENOVIA basic types.
The returned list comprises the following types:
- ProductClass
- ProductRootClass
- ProductComponent
- ProductFunction
- ItemInstance
- PartMaster
- PartVersion
- PartInstance
- StandardPartMaster
- StandardPartVersion
- ProductSpecification
- ProductInstance
- FolderMaster
- FolderVersion
- DocumentMaster
- DocumentRevision
- DocumentVersion
- DocumentFile
- VersionMaster
- Context
- Zone
- Relation
- ConfigObject
- ConfigHandler
- ConfigCategory
- ConfigSpecification
- AFLAction
- ECO
- ECR
- Clash
o UUIDtoFOV
public static HRESULT UUIDtoFOV( | const CORBAAny& | Uuid, |
| CATIVpmFactoryObject_var& | oFactObj) |
-
Retrieves an object from its UUID.
The object is retrieved as a pointer to CATIVpmFactoryObject.
- Parameters:
-
- iUuid
- [in] The object UUID.
- ospFactObj
- [out] The retrieved object as a smart pointer to CATIVpmFactoryObject.
- Returns:
- S_OK if the object is retrieved, E_FAIL if not or if the passed UUID is NULL.
o UpdateFileAttributes
-
Updates the document file attributes from the vault document.
Role: This method updates attributes from the vault document
to the document file object associated with the
preferred iteration and primary format.
- Parameters:
-
- ispDocRev
- [in] The object version / document revision ????
- ipVaultDoc
- [in] A pointer to vault the document
- Returns:
- An HRESULT value.
Legal values: (Those of CATIVpmAttribute::SetValue)
- S_OK
- The document file attributes are successfully updated
- S_FALSE
- An attribute cannot be modified
- E_FAIL
- An error occurred or the attribute does not exist
o createLink
public static HRESULT createLink( | CATIVpmFactoryObject_var& | object1, |
| CATIVpmFactoryObject_var& | object2, |
| const CATUnicodeString& | LinkType) |
-
Creates a link between two objects.
Role: A link can be created between two objects provided that one of the objects,
referred to as the anchor object, owns a connector. The link is set up from the object to
link to the anchor object and uses the anchor object connector whose name is passed using
iConnectorName
. If the anchor object has no connector, or if it has no connector
with that name, a new connector is created using that name to create the link.
- Parameters:
-
- ispAnchorObject
- [in] The anchor object. It should own a connector to enable the link.
- ispObjectToLink
- [in] The object to link to the anchor object.
- iConnectorName
- [in] The name of the connector of the anchor object to use for the link.
- Returns:
- S_OK if the link is successfully created between the two objects, E_FAIL if not.
o deleteLink
public static HRESULT deleteLink( | CATIVpmFactoryObject_var& | object1, |
| CATIVpmFactoryObject_var& | object2, |
| const CATUnicodeString& | LinkType) |
-
Deletes a link between two objects.
- Parameters:
-
- ispAnchorObject
- [in] The anchor object.
- ispObjectToUnLink
- [in] The object to unlink from the anchor object.
- iConnectorName
- [in] The name of the connector of the anchor object to which the object to unlink
is linked.
- Returns:
- S_OK if the link is successfully deleted, E_FAIL if not.
o getFormatFromMaster
public static HRESULT getFormatFromMaster( | CATIVpmFactoryObject_var& | iDocMaster, |
| CATIVpmFactoryObject_var& | oFormat) |
-
Retrieves the document format from the document master.
- Parameters:
-
- iDocMaster
- [in] The document master
- oDocFormat
- [out] The retrieved document format
- Returns:
- S_OK if the object is document format is retrieved, otherwise E_FAIL
o getReverseRelations
public static HRESULT getReverseRelations( | CATIVpmFactoryObject_var& | iFactObj, |
| const CATUnicodeString& | linkType, |
| CATLISTV(CATIVpmFactoryObject_var)& | objList) |
-
Retrieves the objects linked to a given anchor object using a given connector.
This method uses the reverse relations.
- Parameters:
-
- ispAnchorObject
- [in] The anchor object.
- iConnectorName
- [in] The name of the connector of the anchor object to which the objects to retrieve
are linked.
- objList
- [out, delete] The retrieved linked object list.
- Returns:
- S_OK if the object list is successfully retrieved, E_FAIL if not.
o logHistory
-
Creates an history entry on given object.
- Parameters:
-
- iFactObj
- [in] The object for which an history entry should be created.
- iHistoryType
- [in] The history type.
Legal values: To be listed and detailed
- iHistoryDescription
- [in] The history description
Legal values: To be listed and detailed
- Returns:
- S_OK if the object's history entry is successfully created, E_FAIL if not.
o retrieveLinks
public static HRESULT retrieveLinks( | CATIVpmFactoryObject_var& | object1, |
| CATLISTV(CATIVpmFactoryObject_var)& | objList, |
| const CATUnicodeString& | LinkType) |
-
Retrieves the objects linked to a given anchor object using a given connector.
- Parameters:
-
- ispAnchorObject
- [in] The anchor object.
- objList
- [out, delete] The retrieved linked object list.
- iConnectorName
- [in] The name of the connector of the anchor object to which the objects to retrieve
are linked.
- Returns:
- S_OK if the object list is successfully retrieved, E_FAIL if not.
This object is included in the file: DDMNGUtil.h
If needed, your Imakefile.mk should include the module: VX0DDUtil