All Frameworks Class Hierarchy This Framework Indexes
ENOVDesktopDocumentBOCmds Interface ENOVIAVDADocCheckOut
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface ENOVIAVDADocCheckOut
Interface to check-out a document.
Role : This interface checks-out a document revision.
Method Index
- o
get_Result(ENOVIABODocumentFile_var&)
- This method returns the checked-out document file.
- o
get_VaultDocumentURL(SEQUENCE_octet&)
- This method gives access to the vault document URL.
- o
get_VaultName(CATUnicodeString&)
- This method gives the access to the vault name.
- o
put_BObject(ENOVIABusinessObject_var&)
- This method sets the document revision for check-out.
- o
set_BlackBoxMode(int)
- This method sets the BlackBox mode for check-out a CATProduct.
- o
set_CheckOutFileLocation(CATUnicodeString&)
- This method sets check-out file location flag.
- o
set_CheckOutHost(CATUnicodeString&)
- This method sets the check-out host name.
- o
set_FilePath(CATUnicodeString&)
- This method sets the file path.
- o
set_IterSummary(CATUnicodeString&)
- This method sets the iteration summary.
Methods
o get_Result
| public virtual get_Result( | | object) |
-
This method returns the checked-out document file.
- Parameters:
-
- object
- The checked-out document file.
- Returns:
- S_OK in case of success, E_FAIL in case of error.
o get_VaultDocumentURL
| public virtual get_VaultDocumentURL( | | vaultDocURL) |
-
This method gives access to the vault document URL.
- Parameters:
-
- vaultDocURL
- The vault document URL.
- Returns:
- S_OK.
o get_VaultName
| public virtual get_VaultName( | | vaultName) |
-
This method gives the access to the vault name.
- Parameters:
-
- vaultName
- The vault name.
- Returns:
- S_OK.
o put_BObject
| public virtual put_BObject( | const | object) |
-
This method sets the document revision for check-out.
- Parameters:
-
- object
- The document revision.
- Returns:
- S_OK if the object is valid document revision, S_FALSE if not.
o set_BlackBoxMode
| public virtual set_BlackBoxMode( | const | blackBoxMode) |
-
This method sets the BlackBox mode for check-out a CATProduct.
- Parameters:
-
- blackBoxMode
- The value determines whether is BlackBox mode. Default is 0.
Legal values:
- 0
- No BlackBox mode.
- 1
- BlackBox mode.
- Returns:
- S_OK.
o set_CheckOutFileLocation
| public virtual set_CheckOutFileLocation( | const | fileLocation) |
-
This method sets check-out file location flag.
- Parameters:
-
- fileLocation
- The location flag to indicate where the vault file is to be copied to (or whether need to be copied) in this check-out. Default is None.
Legal values:
- None
- No vault file copy-out. Vault document URL can be retrieved through get_VaultDocURL unless it is external document.
- Server
- Vault file will be copied to the server machine. In this case FilePath must be provided.
- Returns:
- S_OK.
o set_CheckOutHost
| public virtual set_CheckOutHost( | const | checkOutHost) |
-
This method sets the check-out host name. Default is "Unknown host".
- Parameters:
-
- checkInHost
- The check-out host name.
- 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 to check-out the file.
- 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.
This object is included in the file: ENOVIAVDADocCheckOut.h
If needed, your Imakefile.mk should include the module: VDD0DocBOCommands