All Frameworks Class Hierarchy This Framework Indexes Previous Next

PLMDocumentInterfaces Interface PLMIDocument

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

interface PLMIDocument

Interface managing Documents.

Role: This interface is implemented by Documents. You cannot use it in a RACE environment.

Method Index

o CheckInFile(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&): Check In a file to the document.
o CheckOutFile(CATUnicodeString&,CATUnicodeString&): Check out a file from the document.
o CreateFile(CATUnicodeString&,CATUnicodeString&): Create a file on the document.
o DeleteFile(CATUnicodeString&): Delete a file on the document.
o DownloadFile(CATUnicodeString&,CATUnicodeString&): Downloads a file from the document.
o GetParents(CATListPtrCATIAdpPLMIdentificator&): Gets Parents of current Document.
o ListFileNames(CATListValCATUnicodeString&): Retrieves the list of file name for a given document.

Methods

o CheckInFile

public virtual CheckInFile(	const	`iOldFileName`,
	const	`iNewFilePath`,
	const	`iFileComment`)

Check In a file to the document.
Role:This method check in a file on the document. Previous version of the file will be replaced.

Parameters:

iOldFileName: [in] Name of the file which is to be replaced.
iNewFilePath: [in] The full path from which the file will be uploaded, it should be an existing file(optional). If the file is not Checked Out an error will be returned.
iFileComment: [in] Comment associated with the file (optional).

Returns:

S_OK if the operation was successfull,
E_FAIL if an error occurs. In this case, more information can be retrieved using the CATError::CATGetLastError method.@see CATError. The possible returned errors are:

DD_CHECKIN_FILEPATH_1 : Invalid input file path. Please check the file name.
DD_CHECKIN_FILEPATH_2 : Invalid input file path: /P1. Please check if the file path is accessible.
DD_CHECKIN_FILEPATH_3 : Invalid input file path: /P1. The file name /P2 already exists on the document.

o CheckOutFile

public virtual CheckOutFile(	const	`iFileName`,
	const	`iCheckOutPath`)

Check out a file from the document.
Role:This method check out the file content in the provided path.

Parameters:

iFileName: [in] The file name to check out. If this file name does not exist, an error will be returned.
iDownloadPath: [in] The path on which the file will be check out. It should be an existing writable directory. The file will be created with name iFileName. If there is a file with that name in the directory, it will be overwritten.

Returns:

S_OK if the operation was successfull,
E_INVALIDARG if the input file name is null, or does not exist.
E_FAIL if an error occurs. In this case, more information can be retrieved using the CATError::CATGetLastError method.@see CATError. The possible returned errors are:

DD_DOWNLOAD_CHECKEDOUT : Already Checked Out: /P1. File is already checked out.
DD_DOWNLOAD_FILENAME : Invalid input file name: /P1. Please check if the file name exists on the document.
DD_DOWNLOAD_FILEPATH : Invalid input path for checkout : /P1. Please check the permissions.

o CreateFile

public virtual CreateFile(	const	`iFilePath`,
	const	`iFileComment`)

Create a file on the document.
Role:This method creates a new file on the document. No file with the same name should exist on the document.

Parameters:

iFilePath: [in] The full path from which the file will be uploaded, it should be an existing file. The file will be created with name of the file at the end of the path. If there is a file with that name on the document, an error will be returned.
iFileComment: [in] Comment associated with the file (optional).

Returns:

S_OK if the operation was successfull,
E_INVALIDARG if the input file path is null, or is file is not found,
E_FAIL if an error occurs. In this case, more information can be retrieved using the CATError::CATGetLastError method.@see CATError. The possible returned errors are:

DD_UPLOAD_FILEPATH_1 : Invalid input file path: /P1. Please check if the file path is accessible.
DD_UPLOAD_FILEPATH_2 : Invalid input file path. The file name /P1 already exists on the document.

o DeleteFile

public virtual DeleteFile( const iFileName)

Delete a file on the document.
Role:This method delete a file on the document.

Parameters:

iFileName: [in] The file name to be deleted. If there is no file with that name on the document, an error will be returned.

Returns:

S_OK if the operation was successfull,
E_INVALIDARG if the input file path is null, or is file is not found,
E_FAIL if an error occurs. In this case, more information can be retrieved using the CATError::CATGetLastError method.@see CATError. The possible returned errors are:

DD_DELETE_FILENAME : Invalid input file name: /P1. Please check if the file name exists on the document.

o DownloadFile

public virtual DownloadFile(	const	`iFileName`,
	const	`iDownloadPath`)

Downloads a file from the document.
Role:This method downloads the file content in the provided path.

Parameters:

iFileName: [in] The file name to be downloaded. If this file name does not exist, an error will be returned.
iDownloadPath: [in] The path on which the file will be downloaded. It should be an existing writable directory. The file will be created with name iFileName. If there is a file with that name in the directory, it will be overwritten.

Returns:

S_OK if the operation was successfull,
E_INVALIDARG if the input file name is null, or does not exist.
E_FAIL if an error occurs. In this case, more information can be retrieved using the CATError::CATGetLastError method.@see CATError. The possible returned errors are:

DD_DOWNLOAD_FILENAME : Invalid input file name: /P1. Please check if the file name exists on the document.
DD_DOWNLOAD_FILEPATH : Invalid input path for download : /P1. Please check the permissions.

o GetParents

public virtual GetParents( oParentsObjects)

Gets Parents of current Document.

Parameters:

oParentsObjects: The Parents of current Document.

Returns:

S_OK if the parents are successfully retrieved.
E_FAIL otherwise.

o ListFileNames

public virtual ListFileNames( oFileNames)

Retrieves the list of file name for a given document.

Parameters:

oFileNames: [out] The list of file name associated to a document.

Returns:

S_OK if the operation was successfull,
E_FAIL if an error occurs. In this case, more information can be retrieved using the CATError::CATGetLastError method.@see CATError. The possible returned errors are:

DD_DOC_NOFILE : No file associated to the document.

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