All Frameworks  Class Hierarchy  This Framework  Indexes   

ENOVDesktopDocumentBOCmds Interface ENOVIAVDADocCheckIn

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


interface ENOVIAVDADocCheckIn

Interface to check-in a document.
Role : This interface checks-in a given document revision with/without a file (physical file, vault file, or external file, etc.). It can also be used to undo the last check-out (see the setting of FileLocation flag below).


Method Index


o get_Result(ENOVIABODocumentFile_var&)
This method gets the checked-in document file.
o put_BObject(ENOVIABusinessObject_var&)
This method sets the document revision for check-in.
o set_CheckInFileLocation(CATUnicodeString&)
This method sets check-in file location flag.
o set_CheckInHost(CATUnicodeString&)
This method sets the check-in host name.
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_FilePath(CATUnicodeString&)
This method sets the file path.
o set_GenNewIter(int)
This method sets the flag to determine whether this check-in should generate a new iteration.
o set_IterSummary(CATUnicodeString&)
This method sets the iteration summary.
o set_PageCount(int)
This method sets the page count of the file.
o set_SubMimeType(CATUnicodeString&)
This method sets the format SubMimeType.
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 checked-in document file.
Parameters:
object
The checked-in document file.
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 revision for check-in.
Parameters:
object
The document revision.
Returns:
S_OK if the object is valid document revision, S_FALSE if not.
o set_CheckInFileLocation
public virtual set_CheckInFileLocation( const fileLocation)
This method sets check-in file location flag.
Parameters:
fileLocation
The location flag to indicate where the physical file is located. Default is None.
Legal values:
None
No file input. Check-in will re-use the vault file pointed by the preferred iteration in this revision. Not recommended unless it is used with GenNewIter flag equals FALSE (no vault file transaction check-in).
Vault
Check-in file is already stored in a vault. In this case the vault document URL is mandatory.
Server
File is located in the server machine. In this case FilePath must be provided.
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.
UndoCheckOut
Undo the last check-out. No vault file transcation involved. Only applicable when the document had been checked-out.
Returns:
S_OK.
o set_CheckInHost
public virtual set_CheckInHost( const checkInHost)
This method sets the check-in host name. Default is "Unknown host".
Parameters:
checkInHost
The check-in host name.
Returns:
S_OK.
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_FilePath
public virtual set_FilePath( const filePath)
This method sets the file path. Mandatory when FileLocation equals "Server"/"External"/"URL".
Parameters:
filePath
The full path of check-in file.
Returns:
S_OK.
o set_GenNewIter
public virtual set_GenNewIter( const Gen_New_Iter)
This method sets the flag to determine whether this check-in should generate a new iteration. Default is TRUE.
Parameters:
Gen_New_Iter
The value determines whether to generate new iteration.
Legal values:
0
No new iteration is generated except the document is checked-in for the first time.
1
New iteration will be generated.
Returns:
S_OK.
o set_IterSummary
public virtual set_IterSummary( const iterSummary)
This method sets the iteration summary. Optional.
Parameters:
iterSummary
The iteration summary.
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. Optional.
Parameters:
subMimeType
The SubMimeType.
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: ENOVIAVDADocCheckIn.h
If needed, your Imakefile.mk should include the module: VDD0DocBOCommands

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