All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ENOVInterfaces Interface ENOVIABODocument

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---System.CATBaseDispatch
        |
        +---System.CATIABase
          |
          +---ENOVInterfaces.ENOVIABusinessObject
            |
            +---ENOVInterfaces.ENOVIABOVersionMaster
              |
              +---ENOVIABODocument
 

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


interface ENOVIABODocument

Interface to define a document as a Business Object.
Role : Document object model contains five document objects. They are document master, document revision, document iteration, document format, and document file. ENOVIABODocument as a Business Object can be viewed as a combination of document master and revision, which provides a handler to access these document objects as a whole (ENOVIABODocumentFile). It also provides methods to access other document objects. Document can be attached to other kinds of object such as attach to TOC as a sheet, attach to Folder, to Part, or another document as linked document. ENOVIABODocument is designed as a Business Object for coherence and to get benefit of the server commands. As it is a kind of VersionMaster object, a Document is versionnable.

See also:
ENOVIABODocumentFile, ENOVIABODocumentTOC, CATIAVPMDocumentVersion, ENOVIABusinessObject


Method Index


o AggregateData(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&)
Associates data to the current Document.
o attach_ToDocument(CATUnicodeString&,ENOVIABODocument_var&)
This method attaches (links) this document to another document with specified link type.
o attach_ToTOC(CATUnicodeString&,long,CATUnicodeString&,CATUnicodeString&,ENOVIABODocumentTOC_var&)
This method attaches this document as a sheet to a TOC.
o createFormat(ENOVIABODocumentFile_var&,CATUnicodeString&,CATUnicodeString&,SEQUENCE_octet&,CATUnicodeString&,CATUnicodeString&,boolean,CATUnicodeString&,boolean,ENOVIABODocumentFile_var&)
This method creates a new format under either a new iteration or the iteration that the input document file belongs to.
o deleteRevision()
This method deletes this document revision (only possible if this revision is the latest version of documnt master).
o detach_FromDocument(CATUnicodeString&,ENOVIABODocument_var&)
This method detaches this document from another document.
o detach_FromTOC(CATUnicodeString&,ENOVIABODocumentTOC_var&)
This method detaches this sheet document from a TOC.
o get_AllFormats(CATListPtrENOVIABO*&)
This method retrieves all the formats in the preferred iteration under this revision.
o get_AllIterations(CATListPtrENOVIABO*&)
This method retrieves all the iterations under this revision.
o get_AllTOCs(CATListPtrENOVIABO*&)
This method retrieves all the TOC versions that this sheet document belongs to.
o get_Data(CATUnicodeString&)
Retrieves the associated Data (Document Path) of the current Document.
o get_DocPersistency(CATUnicodeString&)
Retrieves the Document Persistency of the current Document.
o get_DocType(CATUnicodeString&)
Retrieves the Document Type of the current Document.
o get_FormatsByType(CATUnicodeString&,CATUnicodeString&,CATListPtrENOVIABO*&)
This method retrieves all the formats specified by a format type in preferred iteration under this revision.
o get_LinkType(ENOVIABODocument_var&,CATUnicodeString&)
This method retrieves the link type between this document and the input document.
o get_LinkedDocuments(CATUnicodeString,CATListPtrENOVIABO*&)
This method retrieves all the linked documents based on the link type.
o get_ParentFolder(long,ENOVIABOFolder*&)
Retrieves the Parent Folder of the current Document for a given index.
o get_ParentFolderCount(long&)
Retrieves the number of Parent Folders of the current Document.
o get_PreferredIteration(ENOVIABODocumentFile_var&)
This method retrieves the preferred iteration (primary format) under this revision.
o get_PrimaryFormat(ENOVIABODocumentFile_var&)
This method retrieves the primary format of the preferred iteration under this revision.
o get_TOC(long&,ENOVIABODocumentTOC_var&)
This method retrieves the latest TOC version that this sheet document belongs to.
o isCheckedIn(boolean&)
This method checks whether the document revision is checked-in.
o make_ECControlled()
This method changes the document to be EC controlled.
o set_PreferredIteration(ENOVIABODocumentFile_var&)
This method sets the input iteration to be preferred.
o set_PrimaryFormat(ENOVIABODocumentFile_var&)
This method sets the input format to be primary.

Methods


o AggregateData
public virtual HRESULT __stdcall AggregateData( const CATUnicodeString& iDocUsage,
const CATUnicodeString& iDocPath,
const CATUnicodeString& iDocType,
const CATUnicodeString& iDocPersistency)= 0
Associates data to the current Document.
Parameters:
iDocUsage
The Document Usage.
iDocPath
The Document Path.
iDocType
The Document Type.
iDocPersistency
The Document Persistency.
Returns:
S_OK in case of success, E_FAIL in case of error.
o attach_ToDocument
public virtual HRESULT __stdcall attach_ToDocument( const CATUnicodeString& iLinkType,
const ENOVIABODocument_var& iDocument)=0
This method attaches (links) this document to another document with specified link type.
Parameters:
iLinkType
The link type
Legal values:
AssociatedLink
Documents are linked as associated link (peer-to-peer link).
HierarchicalLink
Documents are linked as hierarchical link. This document is linked as a child document of the target document.
ExternalLink
Documents are linked as external link.
iDocument
The target document.
Returns:
S_OK if successful. E_FAIL in case of error.
o attach_ToTOC
public virtual HRESULT __stdcall attach_ToTOC( const CATUnicodeString& iAttachType,
const long iSheetNumber,
const CATUnicodeString& iSheetDesc,
const CATUnicodeString& iTOCDesc,
const ENOVIABODocumentTOC_var& iTOC)=0
This method attaches this document as a sheet to a TOC.
Parameters:
iAttachType
The attaching flag that indicates how the document is attached to TOC.
Legal values:
AddAsSheet
Add this document as a sheet to TOC. This action converts the document to a sheet of the TOC. If this document is already a sheet of other versions of the input TOC (it was disconnected only from this TOC version), this method will simply reconnect it to the TOC (it retains its old sheet number, so the input sheet number will be ignored in this case). If this document is a sheet of a different TOC, this method will behave like the AddCloneAsSheet case (see below).
AddCloneAsSheet
A copy of the document is created (cloned) and then the cloned document is attached to the TOC as a sheet. Note: the copied document is not identical to the original document. Only its preferred iteration is copied over and no links on the original document are copied.
iSheetNumber
The sheet number.
iSheetDesc
The sheet description.
iTOCDesc
The TOC description.
iTOC
The TOC.
Returns:
S_OK if successful. E_FAIL in case of error.
o createFormat
public virtual HRESULT __stdcall createFormat( const ENOVIABODocumentFile_var& iDocFile,
const CATUnicodeString& fileLocation,
const CATUnicodeString& vaultName,
const SEQUENCE_octet& vaultDocURL,
const CATUnicodeString& filePath,
const CATUnicodeString& hostName,
const boolean SecondaryFormat,
const CATUnicodeString& subMimeType,
const boolean deleteLocalFile,
ENOVIABODocumentFile_var& oDocFile)=0
This method creates a new format under either a new iteration or the iteration that the input document file belongs to.
Parameters:
iDocFile
The input document file. If the input document file is NULL, a new iteration will be created (check-in a file with new iteration generated). Otherwise, either a secondary format is created under the iteration to which the input document file belongs, or a new format is created to replace this input format (see setting parameter SecondaryFormat).
fileLocation
The file location flag to indicate where the file is located. Default is Vault.
Legal values:
Server
File is located in the server machine. In this case FilePath must be provided.
Vault
File is already stored in a vault. In this case vault document URL is mandatory.
External
External document. In this case the FilePath must be provided to hold the external file location description.
URL
URL external document. In this case the FilePath must be provided to hold file URL value.
vaultName
The input vault name. If NULL or empty string, the default vault will be used.
vaultDocURL
The input vault document URL (for fileLocation equals "Vault").
filePath
The input file path . Used when fileLocation equals "Server".
hostName
The host name.
SecondaryFormat
The flag that indicates whether to generate a secondary format. Only used if the input file is not NULL. TRUE to create a secondary format under input file. FALSE to replace the input format.
subMimeType
The format SubMiteType. Usually the format mimetype is induced from the input file extension (or vault file original file extension). If there exists already a same type of format under the iteration, a SubMimeType must be provided to ensure that the combination of format type and SubMimeType is unique.
deleteLocalFile
The flag on whether to delete the local file after it is copied to vault. Only applicable with fileLocation equals "Server". Default is FALSE.
oDocFile
The newly created file.
Returns:
S_OK if successful. E_FAIL in case of error.
o deleteRevision
public virtual HRESULT __stdcall deleteRevision()=0
This method deletes this document revision (only possible if this revision is the latest version of documnt master). If this revision is the only revision of document master, the whole document is going to be deleted.
Returns:
S_OK if successful. E_FAIL in case of error.
o detach_FromDocument
public virtual HRESULT __stdcall detach_FromDocument( const CATUnicodeString& iLinkType,
const ENOVIABODocument_var& iDocument)=0
This method detaches this document from another document.
Parameters:
iLinkType
The link type
Legal values:
AssociatedLink
Detach the associately linked document (peer-to-peer link).
HierarchicalLink
Detach the hierarchically linked document. (This document is linked as a child document of the input document.)
ExternalLink
Detach the externally linked document.
iDocument
The document to be detached from.
Returns:
S_OK if successful. E_FAIL in case of error.
o detach_FromTOC
public virtual HRESULT __stdcall detach_FromTOC( const CATUnicodeString& iDocVID,
const ENOVIABODocumentTOC_var& iTOC)=0
This method detaches this sheet document from a TOC. If this sheet document is a sheet of only this version of the TOC (this document is not a sheet of any other versions of TOC), this method will convert this sheet document to a regular document. In this case the document V_ID will be set to iDocVID.
Parameters:
iDocVID
The new document V_ID.
iTOC
The TOC.
Returns:
S_OK if successful. E_FAIL in case of error.
o get_AllFormats
public virtual HRESULT __stdcall get_AllFormats(CATListPtrENOVIABO*& oDocFiles)=0
This method retrieves all the formats in the preferred iteration under this revision.
Parameters:
oDocFiles
The list of document file objects of the formats.
Returns:
S_OK if successful. S_FALSE if there is no iteration exists (when this document has never been checked-in). E_FAIL in case of error.
o get_AllIterations
public virtual HRESULT __stdcall get_AllIterations(CATListPtrENOVIABO*& oDocFiles)=0
This method retrieves all the iterations under this revision.
Parameters:
oDocFiles
The list of document file objects of the iterations.
Returns:
S_OK if successful. S_FALSE if there is no iteration exists (when this document has never been checked-in). E_FAIL in case of error.
o get_AllTOCs
public virtual HRESULT __stdcall get_AllTOCs(CATListPtrENOVIABO*& oTOCVers)=0
This method retrieves all the TOC versions that this sheet document belongs to.
Parameters:
oTOCVers
The TOC version list that the sheet document belongs to.
Returns:
S_OK if successful. E_FAIL in case of error.
o get_Data
public virtual HRESULT __stdcall get_Data(CATUnicodeString& oDocPath)= 0
Retrieves the associated Data (Document Path) of the current Document.
Parameters:
oDocPath
The Document Path.
Returns:
S_OK in case of success, E_FAIL in case of error.
o get_DocPersistency
public virtual HRESULT __stdcall get_DocPersistency(CATUnicodeString& oDocPersistency)= 0
Retrieves the Document Persistency of the current Document.
Parameters:
oDocPersistency
The Document Persistency.
Returns:
S_OK in case of success, E_FAIL in case of error.
o get_DocType
public virtual HRESULT __stdcall get_DocType(CATUnicodeString& oDocType)= 0
Retrieves the Document Type of the current Document.
Parameters:
oDocType
The Document Type.
Returns:
S_OK in case of success, E_FAIL in case of error.
o get_FormatsByType
public virtual HRESULT __stdcall get_FormatsByType( const CATUnicodeString& iFormatType,
const CATUnicodeString& iSubMimeType,
CATListPtrENOVIABO*& oDocFiles)=0
This method retrieves all the formats specified by a format type in preferred iteration under this revision.
Parameters:
iFormatType
The Mimetype of the format.
iSubMimeType
The SubMimetype of the format.
Legal values:
""
Retrieve the format whose MimeType matches the input iFormatType and SubMimeType is empty.
String value
Retrieve the format whose MimeType matches the input iFormatType and SubMimeType matches this value.
"*"
Retrieve all the formats whose MimeType matches the input iFormatType.
oDocFiles
The returned list of document file objects of the formats.
Returns:
S_OK if successful. S_FALSE if there is no such format found. E_FAIL in case of error.
o get_LinkType
public virtual HRESULT __stdcall get_LinkType( const ENOVIABODocument_var& iDocument,
CATUnicodeString& oLinkType)=0
This method retrieves the link type between this document and the input document.
Parameters:
iDocument
The document that this document maybe linked to.
oLinkType
The link type. It is empty string if these documents are not linked.
Returns:
S_OK if successful. E_FAIL in case of error.
o get_LinkedDocuments
public virtual HRESULT __stdcall get_LinkedDocuments( const CATUnicodeString iLinkType,
CATListPtrENOVIABO*& oDocuments)=0
This method retrieves all the linked documents based on the link type.
Parameters:
iLinkType
The link type
Legal values:
AssociatedLink
Documents are linked as associated link (peer-to-peer link).
HierarchicalLink
Documents are linked as hierarchical link (Child documents of this documents)
ReverseHierarchicalLink
Documents that this document is linked to as hierarchical link (Parent documents of this document).
ExternalLink
Documents are linked as external link.
oDocuments
The list of the linked document.
Returns:
S_OK if successful. E_FAIL in case of error.
o get_ParentFolder
public virtual HRESULT __stdcall get_ParentFolder(long iIndex,
ENOVIABOFolder*& oFolder)= 0
Retrieves the Parent Folder of the current Document for a given index. It must be called after the get_ParentFolderCount method.
Parameters:
iIndex
The index of loop, from 1 to oNbItems.
oFolder
The Folder at the given index.
Returns:
S_OK in case of success, E_FAIL in case of error.
o get_ParentFolderCount
public virtual HRESULT __stdcall get_ParentFolderCount(long& oNbItems)= 0
Retrieves the number of Parent Folders of the current Document.
Parameters:
oNbItems
The number of Parent Folders.
Returns:
S_OK in case of success, E_FAIL in case of error.
o get_PreferredIteration
public virtual HRESULT __stdcall get_PreferredIteration(ENOVIABODocumentFile_var& oDocFile)=0
This method retrieves the preferred iteration (primary format) under this revision.
Parameters:
oDocFile
The document file of the preferred iteration.
Returns:
S_OK if successful. S_FALSE if there is no preferred iteration exists (when this document has never been checked-in). E_FAIL in case of error.
o get_PrimaryFormat
public virtual HRESULT __stdcall get_PrimaryFormat(ENOVIABODocumentFile_var& oDocFile)=0
This method retrieves the primary format of the preferred iteration under this revision. It is equivalent to the get_PreferredIteration method.
Parameters:
oDocFile
The document file of the primary format in the preferred iteration.
Returns:
S_OK if successful. S_FALSE if there is no preferred iteration exists (when this document has never been checked-in). E_FAIL in case of error.
o get_TOC
public virtual HRESULT __stdcall get_TOC(long& oSheetNumber,
ENOVIABODocumentTOC_var& oTOC)=0
This method retrieves the latest TOC version that this sheet document belongs to. Note, this TOC version may not be the latest version of the TOC master, for the case that the document could have been disconnected from it.
Parameters:
oSheetNumber
The sheet number of this sheet document. It equals 0 if the document is not a sheet.
oTOC
The TOC that the sheet document belongs to. It equals NULL if the document is not a sheet.
Returns:
S_OK if successful. E_FAIL in case of error.
o isCheckedIn
public virtual HRESULT __stdcall isCheckedIn(boolean& isCheckedIn)=0
This method checks whether the document revision is checked-in.
Parameters:
isCheckedIn
Whether the document is checked-in.
Returns:
S_OK if successful. E_FAIL in case of error.
o make_ECControlled
public virtual HRESULT __stdcall make_ECControlled()=0
This method changes the document to be EC controlled.
Returns:
S_OK if successful. E_FAIL in case of error.
Deprecated:
V5R16 This method is no longer available. To make a document EC controlled, you must add it to an ECO or ECR as an affected object using the method AddAffectedObject in interface ENOVICWAffectedObjects.
o set_PreferredIteration
public virtual HRESULT __stdcall set_PreferredIteration( const ENOVIABODocumentFile_var& iDocFile)=0
This method sets the input iteration to be preferred.
Parameters:
iDocFile
The iteration to be set to preferred.
Returns:
S_OK if successful. E_FAIL in case of error.
o set_PrimaryFormat
public virtual HRESULT __stdcall set_PrimaryFormat( const ENOVIABODocumentFile_var& iDocFile)=0
This method sets the input format to be primary.
Parameters:
iDocFile
The format to be set to primary.
Returns:
S_OK if successful. E_FAIL in case of error.

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

Copyright © 2003, Dassault Systèmes. All rights reserved.