All Frameworks Class Hierarchy This Framework Indexes
ENOVDesktopDocumentBOCmds Interface ENOVIAVDADocCreateNewFormat
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface ENOVIAVDADocCreateNewFormat
Interface to create a new format.
Role : This interface creates a new (secondary) format under the given document iteration or the preferred iteration of the given document revision with a physical file or vault file.
Method Index
- o
get_Result(ENOVIABODocumentFile_var&)
- This method gets the created document format.
- o
put_BObject(ENOVIABusinessObject_var&)
- This method sets the document (either iteration or revision) that the new format is to be created.
- o
set_DeleteLocalFile(boolean)
- This method sets DeleteLocalFile flag to determine whether to delete the local file after it is copied to vault.
- o
set_FileLocation(CATUnicodeString&)
- This method sets new format file location flag.
- o
set_FilePath(CATUnicodeString&)
- This method sets the file path.
- o
set_HostName(CATUnicodeString&)
- This method sets the format creation host name.
- o
set_PageCount(int)
- This method sets the page count of the file.
- o
set_SubMimeType(CATUnicodeString&)
- This method sets the format SubMimeType, if there is any.
- o
set_VaultDocumentURL(SEQUENCE_octet&)
- This method sets the vault document URL.
- o
set_VaultName(CATUnicodeString&)
- This method sets the vault name.
Methods
o get_Result
| public virtual get_Result( | | object) |
-
This method gets the created document format.
- Parameters:
-
- object
- The new document format.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o put_BObject
| public virtual put_BObject( | const | object) |
-
This method sets the document (either iteration or revision) that the new format is to be created.
- Parameters:
-
- object
- The document.
- Returns:
- S_OK if the object is valid document S_FALSE if not.
o set_DeleteLocalFile
| public virtual set_DeleteLocalFile( | const | iDeleteLocalFile) |
-
This method sets DeleteLocalFile flag to determine whether to delete the local file after it is copied to vault. Only applicable with FileLocation equals "Server". Default is FALSE.
- Parameters:
-
- iDeleteLocalFile
- The flag. TRUE means to delete the local file after check-in.
- Returns:
- S_OK.
o set_FileLocation
| public virtual set_FileLocation( | const | fileLocation) |
-
This method sets new format file location flag.
- 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 the 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.
- Returns:
- S_OK.
o set_FilePath
| public virtual set_FilePath( | const | filePath) |
-
This method sets the file path. Mandatory when FileLocation equals "Server".
- Parameters:
-
- filePath
- The full path of file.
- Returns:
- S_OK.
o set_HostName
| public virtual set_HostName( | const | hostName) |
-
This method sets the format creation host name. Default is "Unknown host".
- Parameters:
-
- hostName
- The format creation host name.
- Returns:
- S_OK.
o set_PageCount
| public virtual set_PageCount( | const | pageCount) |
-
This method sets the page count of the file. Default is 1.
- Parameters:
-
- pageCount
- The page count
- Returns:
- S_OK.
o set_SubMimeType
| public virtual set_SubMimeType( | const | subMimeType) |
-
This method sets the format SubMimeType, if there is any. 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.
- Parameters:
-
- subMimeType
- The SubMimeType. Can be any string as long as its combination with format type is unique within this iteration.
- Returns:
- S_OK.
o set_VaultDocumentURL
| public virtual set_VaultDocumentURL( | const | vaultDocURL) |
-
This method sets the vault document URL. Mandatory when FileLocation equals "Vault".
- Parameters:
-
- vaultDocURL
- The vault document URL.
- Returns:
- S_OK.
o set_VaultName
| public virtual set_VaultName( | const | vaultName) |
-
This method sets the vault name. If not set or set to empty string, the default Vault will be used.
- Parameters:
-
- vaultName
- The vault name.
- Returns:
- S_OK.
This object is included in the file: ENOVIAVDADocCreateNewFormat.h
If needed, your Imakefile.mk should include the module: VDD0DocBOCommands