All Frameworks  Class Hierarchy  This Framework  Previous  Indexes

ENOVaultClientCPP Class ENOVIVaultUserSession

ENOVIVaultUserSession
 

Usage: you must use this class as is. You should never derive it.


public class ENOVIVaultUserSession

This class represents a connection to a given Vault server.
role: This class manages the connection to a given Vault server. It enables to create and delete documents


Method Index


o createDocument(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,ENOVIVaultDocument**,ENOVIVaultError&)
Creates a new document.
o getCATCtxtOId(SEQUENCE_octet&)
Supplies the CATlet context Object Identifier.
o getCurrentTimestamp(CATUnicodeString&,ENOVIVaultError&)
Supplies the current Vault Server timestamp.
o getDocContent(SEQUENCE_octet&,ENOVIVaultDocument**,SEQUENCE_octet&,ENOVIVaultError&)
Supplies the Document content pertainning to the iUUD parameter.
o getDocument(SEQUENCE_octet&,ENOVIVaultDocument**,ENOVIVaultError&)
Retrieves the document on ENOVIVault server pertainning to the supplied Id.
o getDocuments(SEQUENCE_octetColl&,ENOVIVaultReadIterator&,ENOVIVaultError&)
Retrieves a documents collection on ENOVIVault server pertainning to the supplied Id collection.
o getFatherVaultSession(ENOVIVaultSession**)
Supplies the father ENOVIVaultSession object.
o getName(CATUnicodeString&)
Supplies the ENOVIVaultUserSession name.
o getOId(SEQUENCE_octet&)
Supplies the ENOVIVaultUserSession Object Identifier.
o getVaultAliasName(CATUnicodeString&)
Supplies the ENOVIVault Server alias name.
o removeDocument(ENOVIVaultDocument*,ENOVIVaultError&)
Removes the supplied document.
o unBindDocument(ENOVIVaultDocument*,ENOVIVaultError&)
Unbinds a document.

Methods


o createDocument
public HRESULT createDocument(CATUnicodeString& iName,
CATUnicodeString& iDescription,
CATUnicodeString& iMimeType,
CATUnicodeString& iOriginalName,
CATUnicodeString& iOriginalPath,
CATUnicodeString& iOriginalHost,
ENOVIVaultDocument** oppDocument,
ENOVIVaultError& oVaultError)
Creates a new document.
Parameters:
iName
[in] - Document name.
Legal Values: iDescription may be set to "".
iDescription
[in] - Description of the document content.
Legal Values: iDescription may be set to "".
iMimeType
[in] - Document mime type.
Legal Values: iMimeType may be set to "".
iOriginalName
[in] - Document original name.
Legal Values: iOriginalName may be set to "".
iOriginalPath
[in] - Document original path.
Legal Values: iOriginalPath may be set to "".
iOriginalHost
[in] - Document original host.
Legal Values: iOriginalHost may be set to "".
oppDocument
[out] - newly created vault document.
oVaultError
[out] - Details about the error.
o getCATCtxtOId
public HRESULT getCATCtxtOId(SEQUENCE_octet& oCATCtxtOId) const
Supplies the CATlet context Object Identifier.
Parameters:
oCATCtxtOId
[out] - CATlet context Object Identifier.
o getCurrentTimestamp
public HRESULT getCurrentTimestamp(CATUnicodeString& oCurrentTimestamp,
ENOVIVaultError& ve) const
Supplies the current Vault Server timestamp.
Parameters:
oCurrentTimestamp
[out] - remote Vault Server current timestamp.
oVaultError
[out] - Details about the error.
o getDocContent
public HRESULT getDocContent( const SEQUENCE_octet& iOIdDoc,
ENOVIVaultDocument** oppDocument,
SEQUENCE_octet& oDocContent,
ENOVIVaultError& oVaultError)
Supplies the Document content pertainning to the iUUD parameter.
Parameters:
iOIdDoc
[in] - vault document identifier (OID).
oppDocument
[out] - ENOVIVaultDocument object.
Lifecycle rules deviation: oppDocument parameter must only be dealocated using the
unBindDocument method.
oDocContent
[out] - Document content.
You are supposed to delete oDocContent object after user.
oVaultError
[out] - Details about the error.
o getDocument
public HRESULT getDocument( const SEQUENCE_octet& iDocumentIdentifier,
ENOVIVaultDocument** oDocument,
ENOVIVaultError& oVaultError)
Retrieves the document on ENOVIVault server pertainning to the supplied Id.
Parameters:
iDocumentIdentifier
[in] - vault document identifier (OID).
oDocument
[out] - vault document.
oVaultError
[out] - Details about the error.
o getDocuments
public HRESULT getDocuments( const SEQUENCE_octetColl& iDocumentIdentifierColl,
ENOVIVaultReadIterator& oDocumentColl,
ENOVIVaultError& oVaultError) const
Retrieves a documents collection on ENOVIVault server pertainning to the supplied Id collection.
Parameters:
iDocumentIdentifierColl
[in] - vault document identifier collection.
oDocumentColl
[out] - vault documents collection.
oVaultError
[out] - Details about the error.
o getFatherVaultSession
public HRESULT getFatherVaultSession(ENOVIVaultSession** oENOVIVaultSession) const
Supplies the father ENOVIVaultSession object.
Parameters:
oENOVIVaultSession
[out] - double pointer on the father ENOVIVaultSession.
o getName
public HRESULT getName(CATUnicodeString& oName) const
Supplies the ENOVIVaultUserSession name.
Parameters:
oName
[out] - ENOVIVaultUserSession name.
o getOId
public HRESULT getOId(SEQUENCE_octet& oUserSessionOId) const
Supplies the ENOVIVaultUserSession Object Identifier.
Parameters:
oUserSessionOId
[out] - ENOVIVaultUserSession Object Identifier.
o getVaultAliasName
public HRESULT getVaultAliasName(CATUnicodeString& oName) const
Supplies the ENOVIVault Server alias name.
Parameters:
oName
[out] - ENOVIVault Server alias name.
o removeDocument
public HRESULT removeDocument( const ENOVIVaultDocument* ipDocument,
ENOVIVaultError& oVaultError)
Removes the supplied document. Beware to reset iDocument pointer to NULL after method use because
this method delete the pointed document object.
Parameters:
ipDocument
[in] - pointer on the document to remove.
oVaultError
[out] - Details about the error.
o unBindDocument
public HRESULT unBindDocument( const ENOVIVaultDocument* ipDocument,
ENOVIVaultError& oVaultError)
Unbinds a document. Deletes the ENOVIVaultDocument object on the client. Does not remove the actual document on the server.
Parameters:
iURL
[in] - Document to unbind.
iDocument
[in] -
ENOVIVaultDocument object to remove.
oVaultError
[out] - Details about the error.

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

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