All Frameworks Class Hierarchy This Framework Previous Next Indexes
ENOVInterfaces Interface ENOVIABODocumentFile
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---System.CATBaseDispatch
|
+---System.CATIABase
|
+---ENOVInterfaces.ENOVIABusinessObject
|
+---ENOVIABODocumentFile
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface ENOVIABODocumentFile
Interface defines a document file 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. ENOVIABODocumentFile as a
Business Object can be viewed as a combination of all these five document objects, and is often
referred as document file, format, or iteration. This interface provides accesses the vault document
that is linked to this document file. It also provides accesses to other document objects in the
document object model hierarch.
- See also:
- ENOVIABODocument, ENOVIABusinessObject
Method Index
- o
deleteFormat()
- This method deletes this document format (only possible if this format is not the primary format).
- o
deleteIteration()
- This method deletes this document iteration (only possible if this iteration is not preferred).
- o
getDocumentFormat(CATIVpmFactoryObject*&)
- This method gives the object IterationFormat related to this DocFile.
- o
getDocumentIteration(CATIVpmFactoryObject*&)
- This method gives the object Iteration related to this DocFile.
- o
getDocumentRevision(CATIVpmFactoryObject*&)
- This method gives the object DocumentRevision related to this DocFile.
- o
get_AllFormats(CATListPtrENOVIABO*&)
- This method retrieves all the formats of the iteration that this file belongs to.
- o
get_FormatsByType(CATUnicodeString&,CATUnicodeString&,CATListPtrENOVIABO*&)
- This method retrieves all the formats specified by a format type of the iteration that this file belongs to.
- o
get_PrimaryFormat(ENOVIABODocumentFile_var&)
- This method retrieves the primary format of the iteration that this file belongs to.
- o
get_VaultDocument(ENOVIVaultDocument*&)
- This method retrieves Vault document linked by this document file.
- o
get_VaultDocumentURL(SEQUENCE_octet&)
- This method retrieves Vault document URL linked by this document file.
- o
get_VaultName(CATUnicodeString&)
- This method retrieves Vault name that its linked vault document belongs to.
- o
get_ViewerVaultDocument(ENOVIVaultDocument*&)
- This method retrieves thumbnail viewer Vault document linked by this document file.
- o
get_ViewerVaultDocumentURL(SEQUENCE_octet&)
- This method retrieves thumbnail viewer Vault document URL linked by this document file.
- o
get_ViewerVaultName(CATUnicodeString&)
- This method retrieves thumbnail viewer Vault name that its linked vault document belongs to.
- o
update_Format(CATUnicodeString&,CATUnicodeString&,SEQUENCE_octet&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,boolean,ENOVIABODocumentFile_var&)
- This method creates a new format to replaces this one under its iteration of its document revision.
Methods
o deleteFormat
-
This method deletes this document format (only possible if this format is not the primary format).
- Returns:
- S_OK if successful. E_FAIL in case of error.
o deleteIteration
-
This method deletes this document iteration (only possible if this iteration is not preferred).
- Returns:
- S_OK if successful. E_FAIL in case of error.
o getDocumentFormat
-
This method gives the object IterationFormat related to this DocFile.
- Parameters:
-
- Format
- The IterationFormat object.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o getDocumentIteration
-
This method gives the object Iteration related to this DocFile.
- Parameters:
-
- Iteration
- The Iteration object.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o getDocumentRevision
-
This method gives the object DocumentRevision related to this DocFile.
- Parameters:
-
- Revision
- The Revision object.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o get_AllFormats
-
This method retrieves all the formats of the iteration that this file belongs to. The result includes this file itself).
- Parameters:
-
- oDocFiles
- The list of document formats.
- Returns:
- S_OK if successful. E_FAIL in case of error.
o get_FormatsByType
-
This method retrieves all the formats specified by a format type of the iteration that this file belongs to.
- 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_PrimaryFormat
public virtual HRESULT __stdcall get_PrimaryFormat( | ENOVIABODocumentFile_var& | oDocFile)=0 |
-
This method retrieves the primary format of the iteration that this file belongs to.
- Parameters:
-
- oDocFile
- The primary format.
- Returns:
- S_OK if successful. E_FAIL in case of error.
o get_VaultDocument
-
This method retrieves Vault document linked by this document file.
- Parameters:
-
- oVaultDocument
- The vault document.
- Returns:
- S_OK if successful. E_FAIL in case of error.
o get_VaultDocumentURL
public virtual HRESULT __stdcall get_VaultDocumentURL( | SEQUENCE_octet& | oVaultDocURL)=0 |
-
This method retrieves Vault document URL linked by this document file.
- Parameters:
-
- oVaultDocURL
- The vault document URL.
- Returns:
- S_OK if successful. E_FAIL in case of error.
o get_VaultName
-
This method retrieves Vault name that its linked vault document belongs to.
- Parameters:
-
- oVaultName
- The vault name.
- Returns:
- S_OK if successful. E_FAIL in case of error.
o get_ViewerVaultDocument
-
This method retrieves thumbnail viewer Vault document linked by this document file.
- Parameters:
-
- oVaultDocument
- The vault document.
- Returns:
- S_OK if successful. E_FAIL in case of error.
o get_ViewerVaultDocumentURL
public virtual HRESULT __stdcall get_ViewerVaultDocumentURL( | SEQUENCE_octet& | oVaultDocURL)=0 |
-
This method retrieves thumbnail viewer Vault document URL linked by this document file.
- Parameters:
-
- oVaultDocURL
- The vault document URL.
- Returns:
- S_OK if successful. E_FAIL in case of error.
o get_ViewerVaultName
-
This method retrieves thumbnail viewer Vault name that its linked vault document belongs to.
- Parameters:
-
- oVaultName
- The vault name.
- Returns:
- S_OK if successful. E_FAIL in case of error.
o update_Format
-
This method creates a new format to replaces this one under its iteration of its document revision. This method is called when check-in a document with generate-new-iteration flag sets to FALSE.
- Parameters:
-
- 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.
- 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.
This object is included in the file: ENOVIABODocumentFile.h
If needed, your Imakefile.mk should include the module: GUIDENOVInterfaces