All Frameworks Class Hierarchy This Framework Previous Next Indexes
ENOVInterfaces Interface CATIEnovDDManager
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---VPMInterfaces.CATIAVPMTPRootDesktop
|
+---CATIEnovDDManager
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIEnovDDManager
Interface to the DDManager.
Role: The DDManager (Document Manager) provides methods to create, retrieve, and delete documents, manage
document versioning (revisions, iterations, formats, etc.), and other related methods.
IMPORTANT changes in R14: revision contains no dummy iteration anymore. This change affects the behaviors of
method get_DocIterationCounts and get_DocIterations.
- See also:
- ENOVIDocumentRevision, ENOVIDocumentIteration, ENOVIIterationFormat, ENOVIDocumentFile, ENOVIABODocument, ENOVIABODocumentFile
Method Index
- o
AutoNumberGeneration(CATUnicodeString&,CATUnicodeString&)
- Generates a document ID.
- o
CreateDocRev(CATIAVPMObjectVersion*,CATIAVPMObjectVersion*&)
- Creates a new document revision by revision object.
- o
CreateDocRev(CORBAAny&,CATIAVPMObjectVersion*&)
- Creates a new document revision by UUID.
- o
CreateDocument(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATListOfCATUnicodeString&,CATListOfCATUnicodeString&,CATIAVPMDocumentMaster*&)
- Creates a new document.
- o
CreateFile(CORBAAny&,int,CORBAAny&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,int,CATIVpmFactoryObject_var&)
- Create a document file object.
- o
CreateFormat(CORBAAny&,int,CATUnicodeString&,CATUnicodeString&,boolean&,CATIVpmFactoryObject_var&)
- Creates a document format with sub MiMETYPE.
- o
CreateFormat(CORBAAny&,int,CATUnicodeString&,boolean&,CATIVpmFactoryObject_var&)
- Creates a document format.
- o
CreateIteration(CORBAAny&,CATIVpmFactoryObject_var&)
- Creates document iteration on a revision.
- o
CreateNewPrefix(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&)
- Creates a new prefix.
- o
CreateSecuredFile(CATIVpmFactoryObject*,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATIVpmFactoryObject_var&)
- Create a secured file object.
- o
DeleteDocFile(CATIVpmFactoryObject_var&)
- Deletes a file object.
- o
DeleteDocFormat(CATIVpmFactoryObject_var&)
- Deletes a format.
- o
DeleteDocument(CORBAAny&)
- Deletes a document master.
- o
DeleteIteration(CORBAAny&)
- Deletes a document iteration.
- o
DeleteRevision(CORBAAny&)
- Deletes a document revision.
- o
FindDocument(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATListOfCATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATLISTV(CATIAVPMDocumentMaster_var)&,int&)
- Retrieves documents.
- o
RollbackAutoNumGen(CATUnicodeString&)
- Rollback on auto number generation.
- o
UpdateDocument(CORBAAny&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATListOfCATUnicodeString&,CATListOfCATUnicodeString&,CATUnicodeString&,CATUnicodeString&)
- Updates a document with new attributes.
- o
UpdateRevision(CORBAAny&,CATUnicodeString&,boolean&,CATIAVPMObjectVersion*&)
- Updates a document revision with new attributes.
- o
getDocRevisionHistory(CORBAAny&,CATLISTV(CATBaseUnknown_var)&)
- Retrieves revision's history object.
- o
getObjectHistory(CORBAAny&,CATLISTV(CATBaseUnknown_var)&)
- Retrieves an object's history object.
- o
getRevisionID(CATIVpmFactoryObject_var,CATUnicodeString&)
- Retrieves revision's version.
- o
get_DocFileCount(CATIVpmFactoryObject_var&,long&)
- Retrieves the count of all the files in a format.
- o
get_DocFiles(CATIVpmFactoryObject_var&,CATLISTV(CATIVpmFactoryObject_var)&)
- Retrieves document file object.
- o
get_DocFormatCount(CATIVpmFactoryObject_var&,long&)
- Retrieves the count of an iteration's formats.
- o
get_DocFormats(CATIVpmFactoryObject_var&,CATLISTV(CATIVpmFactoryObject_var)&)
- Retrieves an iteration's formats.
- o
get_DocIterationCount(CATIAVPMObjectVersion*&,long&)
- Retrieves revision's iteration counts.
- o
get_DocIterations(CATIAVPMObjectVersion*&,CATLISTV(CATIVpmFactoryObject_var)&)
- Retrieves revision's iterations.
- o
get_FormatFromDocFile(CATIVpmFactoryObject_var&,CATIVpmFactoryObject_var&)
- Retrieves format from a file.
- o
get_IterationFromFormat(CATIVpmFactoryObject_var&,CATIVpmFactoryObject_var&)
- Retrieves iteration from a format.
- o
get_PreferredIteration(CATIAVPMObjectVersion*&,CATIVpmFactoryObject_var&)
- Retrieves revision's preferred iteration.
- o
get_PreferredRevision(CATIVpmFactoryObject_var,CATIAVPMObjectVersion*&)
- Retrieves document's preferred revision by object.
- o
get_PreferredRevision(CORBAAny&,CATIAVPMObjectVersion*&)
- Retrieves document's preferred revision by UUID.
- o
get_RevisionFromIteration(CATIVpmFactoryObject_var&,CATIAVPMObjectVersion*&)
- Retrieves revision from an iteration.
- o
set_PreferredIteration(CORBAAny&)
- Sets given iteration as preferred.
- o
set_PreferredRevision(CORBAAny&)
- Sets given revision as preferred revision.
- o
set_ViewerAttributes(CATIVpmFactoryObject_var,CATUnicodeString,CATUnicodeString,CORBAAny&)
- Set pre-Viewer's attributes.
- o
whereUsedActionIDs(CATIVpmFactoryObject_var,CATListOfCATUnicodeString&)
- Retrieves where used Actions' IDs.
- o
whereUsedECs(CATIVpmFactoryObject_var,CATUnicodeString,CATLISTV(CATIVpmFactoryObject_var)&)
- Retrieves where used ECs.
- o
whereUsedParts(CATIVpmFactoryObject_var,CATLISTV(CATIVpmFactoryObject_var)&)
- Retrieves where used parts.
- o
whereUsedProdSpecs(CATIVpmFactoryObject_var,CATLISTV(CATIVpmFactoryObject_var)&)
- Retrieves where used Prod Specs.
Methods
o AutoNumberGeneration
-
Generates a document ID.
- Parameters:
-
- iPrefix
- The prefix
- oDocumentID
- The document ID
o CreateDocRev
-
Creates a new document revision by revision object.
- Parameters:
-
- iOldRevision
- The old revision
- oNewRevision
- The new revision
o CreateDocRev
-
Creates a new document revision by UUID.
- Parameters:
-
- iRevUuid
- The old revision uuid
- oNewRevision
- The new revision
o CreateDocument
-
Creates a new document.
- Parameters:
-
- iDocNum
- The document ID
- iDocTitle
- The document name
- iDocDesc
- The document description
- iDocType
- The document type (not used anymore)
- iDocClassFields
- The list of document classification fields
- iDocKeyWords
- The list of document keywords
- oDocMaster
- The document master object
o CreateFile
-
Create a document file object.
- Parameters:
-
- iFormatUuid
- The format uuid
- iControlCode
- The parameter of control code
- iVaultItemUuid
- The VaultItem Uuid
- iVaultName
- The vault name
- iCheckInHost
- The CheckIn host name
- iCheckInPath
- The CheckIn path name
- iCheckInFileName
- The CheckIn file name
- iFileNum
- The file number (not used any more)
- oDocFile
- The document file object
- Deprecated:
- V5R14
Use ENOVIDocumentRevision->CreateFormat in ENOVDDManager instead.
o CreateFormat
-
Creates a document format with sub MiMETYPE.
- Parameters:
-
- iIterUuid
- The iteration uuid
- iControlCode
- The parameter of the control code
- iMimeType
- The format MIMETYPE
- iSubMimeType
- The format sub MIMETYPE
- iIsURL
- The parameter of whether document is a URL or not
- oDocFormat
- The document format
- Deprecated:
- V5R14
Use ENOVIDocumentRevision->CreateFormat in ENOVDDManager instead.
o CreateFormat
public virtual HRESULT CreateFormat( | const CORBAAny& | iIterUuid, |
| const int | iControlCode, |
| const CATUnicodeString& | iMimeType, |
| const boolean& | iIsURL, |
| CATIVpmFactoryObject_var& | oDocFormat) = 0 |
-
Creates a document format.
- Parameters:
-
- iIterUuid
- The iteration uuid
- iControlCode
- The parameter of the control code
- iMimeType
- The format MIMETYPE
- iIsURL
- The parameter of whether document is a URL or not
- oDocFormat
- The document format
- Deprecated:
- V5R14
Use ENOVIDocumentRevision->CreateFormat in ENOVDDManager instead.
o CreateIteration
public virtual HRESULT CreateIteration( | const CORBAAny& | iRevUuid, |
| CATIVpmFactoryObject_var& | oDocIteration) = 0 |
-
Creates document iteration on a revision.
- Parameters:
-
- iRevUuid
- The document revision uuid
- oDocIteration
- The document iteration
- Deprecated:
- V5R14
Use ENOVIDocumentRevision->AggregateIteration in ENOVDDManager instead.
o CreateNewPrefix
-
Creates a new prefix.
- Parameters:
-
- iPrefix
- The prefix
- iStartingNumber
- The starting number
- iIncrementSize
- The increment size
- oDocumentID
- The document ID
o CreateSecuredFile
-
Create a secured file object.
- Parameters:
-
- iDocFormat
- The format object
- iCheckInHost
- The CheckIn host name
- iCheckInPath
- The CheckIn path name
- iCheckInFileName
- The CheckIn file name
- oDocFile
- The document file object
- Deprecated:
- V5R14
Use ENOVIDocumentRevision->CreateFormat in ENOVDDManager instead.
o DeleteDocFile
public virtual HRESULT DeleteDocFile( | CATIVpmFactoryObject_var& | iDocFile)=0 |
-
Deletes a file object.
- Parameters:
-
- iDocFile
- The file object
- Deprecated:
- V5R14
Document file is automatically deleted when and only when a format is deleted.
o DeleteDocFormat
public virtual HRESULT DeleteDocFormat( | CATIVpmFactoryObject_var& | iDocFormat)=0 |
-
Deletes a format.
- Parameters:
-
- iDocFormat
- The format object
o DeleteDocument
-
Deletes a document master.
- Parameters:
-
- iMasterUuid
- The master uuid
o DeleteIteration
-
Deletes a document iteration.
- Parameters:
-
- iIterUuid
- The document iteration uuid
o DeleteRevision
-
Deletes a document revision.
- Parameters:
-
- iRevUuid
- The document revision uuid
o FindDocument
-
Retrieves documents.
- Parameters:
-
- iDocNum
- The document ID
- iDocTitle
- The document name
- iDocDesc
- The document description
- iDocType
- The document type (not used anymore)
- iDocKeyWords
- The list of document keywords
- iDocUser
- The document creator
- iDocOrg
- The document organization
- oDocMasters
- The list of matching documents
- isCaseUnSensitive
- Search case sensitivity.
o RollbackAutoNumGen
-
Rollback on auto number generation.
- Parameters:
-
- iPrefix
- The prefix
o UpdateDocument
-
Updates a document with new attributes.
- Parameters:
-
- iMasterUuid
- The document master ID
- iDocTitle
- The document name
- iDocDesc
- The document description
- iDocType
- The document type (not used anymore)
- iDocClassFields
- The list of document classification fields
- iDocKeyWords
- The list of document keywords
- iDocUser
- The document creator
- iDocOrg
- The document organization
- Deprecated:
- V5R14
Use VPMDesktopObjects->CATIAVPMVDAModify2 in VPMDesktopObjects instead
o UpdateRevision
-
Updates a document revision with new attributes.
- Parameters:
-
- iRevUuid
- The document revision uuid
- iDescription
- The revision's description
- iIsExternal
- The parameter of whether the revision is External
- oDocRevision
- The updated revision
- Deprecated:
- V5R14
Use VPMDesktopObjects->CATIAVPMVDAModify2 in VPMDesktopObjects instead
o getDocRevisionHistory
-
Retrieves revision's history object.
- Parameters:
-
- iRevUuid
- The document revision uuid
- oListOfHistory
- The list of history objects
o getObjectHistory
-
Retrieves an object's history object.
- Parameters:
-
- iUuid
- The uuid of an object
- oListOfHistory
- The list of history objects
o getRevisionID
-
Retrieves revision's version.
- Parameters:
-
- iFactObj
- The input object
- oRevIDs
- The version
o get_DocFileCount
public virtual HRESULT get_DocFileCount( | CATIVpmFactoryObject_var& | iDocFormat, |
| long& | oNbFiles) = 0 |
-
Retrieves the count of all the files in a format.
- Parameters:
-
- iDocFormat
- The format object
- oNbFiles
- The count of file objects
o get_DocFiles
public virtual HRESULT get_DocFiles( | CATIVpmFactoryObject_var& | iDocFormat, |
| CATLISTV(CATIVpmFactoryObject_var)& | oDocFiles) = 0 |
-
Retrieves document file object.
- Parameters:
-
- iDocFormat
- The format object
- oDocFiles
- The list of file objects
o get_DocFormatCount
public virtual HRESULT get_DocFormatCount( | CATIVpmFactoryObject_var& | iDocIteration, |
| long& | oNbFormats) = 0 |
-
Retrieves the count of an iteration's formats.
- Parameters:
-
- iDocIteration
- The document iteration object
- oNbFormats
- The count of the format objects
o get_DocFormats
public virtual HRESULT get_DocFormats( | CATIVpmFactoryObject_var& | iDocIteration, |
| CATLISTV(CATIVpmFactoryObject_var)& | oDocFormats) = 0 |
-
Retrieves an iteration's formats.
- Parameters:
-
- iDocIteration
- The document iteration object
- oDocFormats
- The list of format objects
o get_DocIterationCount
-
Retrieves revision's iteration counts. Improtant change in R14: there is no dummy iteration in revision anymore.
The returned number in this method is exact count of total iterations.
- Parameters:
-
- iDocRevision
- The document revision
- oNbIterations
- The count of iterations
o get_DocIterations
-
Retrieves revision's iterations. Improtant change in R14: there is no dummy iteration in revision anymore.
The returned object list in this method contains no dummy iteration.
- Parameters:
-
- iDocRevision
- The document revision
- oDocIterations
- The list of iterations
o get_FormatFromDocFile
public virtual HRESULT get_FormatFromDocFile( | const CATIVpmFactoryObject_var& | iDocFile, |
| CATIVpmFactoryObject_var& | oDocFormat)=0 |
-
Retrieves format from a file.
- Parameters:
-
- iDocFile
- The file object
- oDocFormat
- The format object
o get_IterationFromFormat
public virtual HRESULT get_IterationFromFormat( | const CATIVpmFactoryObject_var& | iDocFormat, |
| CATIVpmFactoryObject_var& | oDocIteration)=0 |
-
Retrieves iteration from a format.
- Parameters:
-
- iDocFormat
- The format object
- oDocIteration
- The iteration object
o get_PreferredIteration
-
Retrieves revision's preferred iteration.
- Parameters:
-
- iDocRevision
- The document revision
- oDocIteration
- The preferred iteration
o get_PreferredRevision
-
Retrieves document's preferred revision by object.
- Parameters:
-
- iMasterFactObj
- The document master object
- oDocRCATEnovDDManager.cppevision
- The preferred revision
o get_PreferredRevision
-
Retrieves document's preferred revision by UUID.
- Parameters:
-
- iMasterUuid
- The document master uuid
- oDocRevision
- The preferred revision
o get_RevisionFromIteration
-
Retrieves revision from an iteration.
- Parameters:
-
- iDocIteration
- The iteration object
- oDocRevision
- The revision object
o set_PreferredIteration
-
Sets given iteration as preferred.
- Parameters:
-
- iDocIterUuid
- The document iteration uuid
o set_PreferredRevision
-
Sets given revision as preferred revision.
- Parameters:
-
- iRevUuid
- The document revision uuid
o set_ViewerAttributes
-
Set pre-Viewer's attributes.
- Parameters:
-
- iDocFormat
- The input docFormat object
- iViewMimeType
- The viewer's MIMEType
- iVaultName
- The docFile's vault name
- iVaultUuid
- The docFile's vault UUID
- Deprecated:
- V5R14
Pre-viewer attributes are no long in DocFormat and DocFile objects. Instead, a secondary format is created for pre-viewer.
o whereUsedActionIDs
-
Retrieves where used Actions' IDs.
- Parameters:
-
- iFactObj
- The input object
- oActionIDs
- The list of affected Actions' IDs.
o whereUsedECs
-
Retrieves where used ECs.
- Parameters:
-
- iFactObj
- The input object
- iObjType
- The input EC types (could be "ENOVIA_ECO", "ENOVIA_AFLAction", or "")
- oObjList
- The list of part objects that are linked to input object
o whereUsedParts
-
Retrieves where used parts.
- Parameters:
-
- iObj
- The input object
- oObjList
- The list of part objects that are linked to input object
o whereUsedProdSpecs
-
Retrieves where used Prod Specs.
- Parameters:
-
- iObj
- The input object
- oObjList
- The list of prodspec objects that are linked to input object
This object is included in the file: CATIEnovDDManager.h
If needed, your Imakefile.mk should include the module: GUIDENOVInterfaces