All Frameworks Class Hierarchy This Framework Previous Next Indexes
ENOVaultClientCPP Class ENOVIVaultSession
ENOVIVaultSession
Usage: you must use this class as is. You should never derive it.
public class ENOVIVaultSession
Class to manage client vault session.
role: This class manages all the connections to the vaults
It supplies methods to bind existing documents by URL
and to get ENOVIVaultUserSession Objects.
Method Index
- o
abort(ENOVIVaultError&)
- Aborts all the work done in the current UserSession.
- o
abort(SEQUENCE_octet&,ENOVIVaultError&)
- Aborts all the work done in the current UserSession.
- o
bindAndgetDocContent(SEQUENCE_octet&,ENOVIVaultDocument**,SEQUENCE_octet&,ENOVIVaultError&)
- Supplies the Document content pertainning to the
iUUD
parameter.
- o
bindAndgetDocContent(SEQUENCE_octet&,SEQUENCE_octet&,ENOVIVaultDocument**,SEQUENCE_octet&,ENOVIVaultError&)
- Supplies the Document content pertainning to the
iUUD
parameter.
- o
bindDocument(SEQUENCE_octet&,ENOVIVaultDocument**,ENOVIVaultError&)
- Supplies the ENOVIVaultDocument object pertainning to the
iUUD
parameter.
- o
bindDocument(SEQUENCE_octet&,SEQUENCE_octet&,ENOVIVaultDocument**,ENOVIVaultError&)
- Supplies the ENOVIVaultDocument object pertainning to the
iUUD
parameter.
- o
bindDocuments(SEQUENCE_octetColl&,ENOVIVaultReadIterator&,ENOVIVaultError&)
- Retrieves a collection of ENOVIVaultDocument objects each pertainning to the
iUUD
collection parameter.
- o
bindDocuments(SEQUENCE_octetColl&,SEQUENCE_octet&,ENOVIVaultReadIterator&,ENOVIVaultError&)
- Retrieves a collection of ENOVIVaultDocument objects each pertainning to the
iUUD
collection parameter.
- o
close(ENOVIVaultError&)
- Closes the user session
It aborts all the work done in the current UserSession and do not reinit
the UserSession after that.
- o
close(SEQUENCE_octet&,ENOVIVaultError&)
- Closes the user session
It aborts all the work done in the current UserSession and do not reinit
the UserSession after that.
- o
closeProxy(ENOVIVaultError&)
- Closes the user session proxy
It aborts all the work done in the current UserSession and do not reinit
the UserSession after that.
- o
closeProxy(SEQUENCE_octet&,ENOVIVaultError&)
- Closes the user session proxy
It aborts all the work done in the current UserSession and do not reinit
the UserSession after that.
- o
commit(ENOVIVaultError&)
- Commits all the work done during the UserSession.
- o
commit(SEQUENCE_octet&,ENOVIVaultError&)
- Commits all the work done during the UserSession.
- o
connectCache(CATUnicodeString&,CATUnicodeString&,int&,ENOVIVaultError&)
- Reconnect the related Vault Cache Server.
- o
disconnectCache(CATUnicodeString&,CATUnicodeString&,int&,ENOVIVaultError&)
- Disconnect the related Vault Cache Server from VaultServer.
- o
endUserSession(ENOVIVaultUserSession*,ENOVIVaultError&)
- Ends a user session.
- o
getProperty(CATUnicodeString&,CATUnicodeString&)
- Supplies the property value pertainning to the input property name.
- o
getUserSession(CATUnicodeString&,ENOVIVaultUserSession**,ENOVIVaultError&,SEQUENCE_octet*)
- Supplies a ENOVIVaultUserSession object pertainning to the requested ENOVIVault Server.
- o
getUserSession(CATUnicodeString&,SEQUENCE_octet&,ENOVIVaultUserSession**,ENOVIVaultError&,SEQUENCE_octet*)
- Supplies a ENOVIVaultUserSession object pertainning to the requested ENOVIVault Server.
- o
isAliasCached(CATUnicodeString&,CATBoolean&,ENOVIVaultError&)
- Specifies if a given alias is cached or not.
- o
isCacheUsed(CATBoolean&,ENOVIVaultError&)
- Specifies if one of the Vault Alias Name defined in Vault Client properties is cached.
- o
isDocumentCached(SEQUENCE_octet&,CATBoolean&,ENOVIVaultError&)
- Specifies if a given document is cached or not.
- o
offLine(CATUnicodeString&,CATUnicodeString&,int&,ENOVIVaultError&)
- Offline the related Vault Server.
- o
offLine(CATUnicodeString&,ENOVIVaultError&)
- Offline the related Vault Server.
- o
onLine(CATUnicodeString&,CATUnicodeString&,int&,ENOVIVaultError&)
- Online the related Vault Server.
- o
onLine(CATUnicodeString&,ENOVIVaultError&)
- Online the related Vault Server.
- o
prepare(ENOVIVaultError&)
- Prepares all the work done during the UserSession.
- o
prepare(SEQUENCE_octet&,ENOVIVaultError&)
- Prepares all the work done during the UserSession.
- o
reloadProperties(CATUnicodeString&,CATUnicodeString&,int&,ENOVIVaultError&)
- Reload the whole set of properties on the related Vault Server.
- o
reloadProperties(CATUnicodeString&,ENOVIVaultError&)
- Reload the whole set of properties on the related Vault Server.
- o
removeUserSession(ENOVIVaultUserSession*,ENOVIVaultError&)
- Removes a user session.
- o
removeUserSessionProxy(ENOVIVaultUserSession*,ENOVIVaultError&)
- Removes a user session proxy.
- o
setVSTraceLevel(CATUnicodeString&,int&,int&,ENOVIVaultError&)
- Sets the vault server trace level.
- o
shutdown(CATUnicodeString&,CATUnicodeString&,int&,int&,ENOVIVaultError&)
- Shutdown the related Vault Server.
- o
shutdown(CATUnicodeString&,int&,ENOVIVaultError&)
- Shutdown the related Vault Server.
- o
unBindDocument(ENOVIVaultDocument*,ENOVIVaultError&)
- Unbinds a document.
- o
unPrepare(ENOVIVaultError&)
- Unprepares all the work done during the UserSession.
- o
unPrepare(SEQUENCE_octet&,ENOVIVaultError&)
- Unprepares all the work done during the UserSession.
Methods
o abort
-
Aborts all the work done in the current UserSession.
The UserSession is reinitialized after that.
- Parameters:
-
- oVaultError
- [out] - Details about the error.
- Returns:
- S_OK, E_FAIL.
o abort
-
Aborts all the work done in the current UserSession.
The UserSession is reinitialized after that.
- Parameters:
-
- ibvContextOId
- [in] - CATlet context OId.
- oVaultError
- [out] - Details about the error.
- Returns:
- S_OK, E_FAIL.
o bindAndgetDocContent
-
Supplies the Document content pertainning to the
iUUD
parameter.
- Parameters:
-
- iURL
- [in] - Document's URL to bind.
- 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.
- Returns:
- S_OK, E_FAIL.
- Deprecated:
- V5R12
o bindAndgetDocContent
-
Supplies the Document content pertainning to the
iUUD
parameter.
- Parameters:
-
- iURL
- [in] - Document's URL to bind.
- ibvContextOId
- [in] - CATlet context 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.
- Returns:
- S_OK, E_FAIL.
o bindDocument
-
Supplies the ENOVIVaultDocument object pertainning to the
iUUD
parameter.
- Parameters:
-
- iURL
- [in] - Document's URL to bind.
- oppDocument
- [out] - ENOVIVaultDocument object.
Lifecycle rules deviation: oppDocument parameter must only be dealocated using the
unBindDocument method.
- oVaultError
- [out] - Details about the error.
- Returns:
- S_OK, E_FAIL.
- Deprecated:
- V5R12
o bindDocument
-
Supplies the ENOVIVaultDocument object pertainning to the
iUUD
parameter.
- Parameters:
-
- iURL
- [in] - Document's URL to bind.
- ibvContextOId
- [in] - CATlet context OId.
- oppDocument
- [out] - ENOVIVaultDocument object.
Lifecycle rules deviation: oppDocument parameter must only be dealocated using the
unBindDocument method.
- oVaultError
- [out] - Details about the error.
- Returns:
- S_OK, E_FAIL.
o bindDocuments
-
Retrieves a collection of ENOVIVaultDocument objects each pertainning to the
iUUD
collection parameter.
- Parameters:
-
- iURLs
- [in] - ENOVIVaultDocument URL collection to bind.
- oDocuments
- [out] - ENOVIVaultDocument collection.
- oVaultError
- [out] - Details about the error.
- Returns:
- S_OK, E_FAIL.
- Deprecated:
- V5R12
o bindDocuments
-
Retrieves a collection of ENOVIVaultDocument objects each pertainning to the
iUUD
collection parameter.
- Parameters:
-
- iURLs
- [in] - ENOVIVaultDocument URL collection to bind.
- ibvContextOId
- [in] - CATlet context OId.
- oDocuments
- [out] - ENOVIVaultDocument collection.
- oVaultError
- [out] - Details about the error.
- Returns:
- S_OK, E_FAIL.
o close
-
Closes the user session
It aborts all the work done in the current UserSession and do not reinit
the UserSession after that.
- Parameters:
-
- oVaultError
- [out] - Details about the error.
- Returns:
- S_OK, E_FAIL.
o close
-
Closes the user session
It aborts all the work done in the current UserSession and do not reinit
the UserSession after that.
- Parameters:
-
- ibvContextOId
- [in] - CATlet context OId.
- oVaultError
- [out] - Details about the error.
- Returns:
- S_OK, E_FAIL.
o closeProxy
-
Closes the user session proxy
It aborts all the work done in the current UserSession and do not reinit
the UserSession after that.
- Parameters:
-
- oVaultError
- [out] - Details about the error.
- Returns:
- S_OK, E_FAIL.
o closeProxy
-
Closes the user session proxy
It aborts all the work done in the current UserSession and do not reinit
the UserSession after that.
- Parameters:
-
- ibvContextOId
- [in] - CATlet context OId.
- oVaultError
- [out] - Details about the error.
- Returns:
- S_OK, E_FAIL.
o commit
-
Commits all the work done during the UserSession.
- Parameters:
-
- oVaultError
- [out] - Details about the error.
- Returns:
- S_OK, E_FAIL.
o commit
-
Commits all the work done during the UserSession.
- Parameters:
-
- ibvContextOId
- [in] - CATlet context OId.
- oVaultError
- [out] - Details about the error.
- Returns:
- S_OK, E_FAIL.
o connectCache
-
Reconnect the related Vault Cache Server.
- Parameters:
-
- iVaultServerName
- [in] - Vault Server Name (server marker).
- iVaultServerHost
- [in] - Vault Server Host.
- iVaultServerPort
- [in] - Vault Server Port (Orbix daemon port).
- oVaultError
- [out] - Details about the error.
- Returns:
- S_OK, E_FAIL
o disconnectCache
-
Disconnect the related Vault Cache Server from VaultServer.
- Parameters:
-
- iVaultServerName
- [in] - Vault Server Name (server marker).
- iVaultServerHost
- [in] - Vault Server Host.
- iVaultServerPort
- [in] - Vault Server Port (Orbix daemon port).
- oVaultError
- [out] - Details about the error.
- Returns:
- S_OK, E_FAIL
o endUserSession
-
Ends a user session.
- Parameters:
-
- ipENOVIVaultUserSession
- [in] -
ENOVIVaultUserSession object to end.
- oVaultError
- [out] - Details about the error.
- Returns:
- S_OK, E_FAIL.
o getProperty
-
Supplies the property value pertainning to the input property name.
- Parameters:
-
- iPropertyName
- [in] - property name.
- oValue
- [out] - property value.
- Returns:
- S_OK, E_FAIL.
o getUserSession
-
Supplies a ENOVIVaultUserSession object pertainning to the requested ENOVIVault Server.
If the
ENOVIVaultUserSession object doesn't exist yet, it will be created.
If you are not the transaction master, it will be called in order to manage transaction
properly on the newly created ENOVIVaultUserSession object.
- Parameters:
-
- iENOVIVaultAliasName
- [in] - ENOVIVault Server alias name.
- oppENOVIVaultUserSession
- [out] - ENOVIVaultUserSession object.
- oVaultError
- [out] - Details about the error.
- ipbvUSOId
- [in] - ENOVIVaultUserSession Identifier valuated by default. Do not change the default value.
- Returns:
- S_OK, E_FAIL.
- Deprecated:
- V5R12
o getUserSession
-
Supplies a ENOVIVaultUserSession object pertainning to the requested ENOVIVault Server.
If the
ENOVIVaultUserSession object doesn't exist yet, it will be created.
If you are not the transaction master, it will be called in order to manage transaction
properly on the newly created ENOVIVaultUserSession object.
- Parameters:
-
- isvVaultAliasName
- [in] - Vault Server alias name.
- ibvContextOId
- [in] - CATlet context OId.
- oppENOVIVaultUserSession
- [out] - ENOVIVaultUserSession object.
- oVaultError
- [out] - Details about the error.
- ipbvUSOId
- [in] - ENOVIVaultUserSession Identifier valuated by default. Do not change the default value.
- Returns:
- S_OK, E_FAIL.
o isAliasCached
-
Specifies if a given alias is cached or not.
- Parameters:
-
- iAliasName
- [in] - Vault Alias Name.
- oIsAliasCached
- [out] - true if the Vault Alias Name is cached, false otherwise.
- Returns:
- S_OK, E_FAIL
o isCacheUsed
-
Specifies if one of the Vault Alias Name defined in Vault Client properties is cached.
- Parameters:
-
- oIsCacheUsed
- [out] - true if one of the Vault Alias Name defined in Vault Client properties is cached, false otherwise.
- Returns:
- S_OK, E_FAIL
o isDocumentCached
-
Specifies if a given document is cached or not.
- Parameters:
-
- iURL
- IVaultDocument URL.
- oIsDocCached
- [out] - true if the document is cached, false otherwise.
- Returns:
- S_OK, E_FAIL
o offLine
-
Offline the related Vault Server.
- Parameters:
-
- iVaultServerName
- [in] - Vault Server Name (server marker).
- iVaultServerHost
- [in] - Vault Server Host.
- iVaultServerPort
- [in] - Vault Server Port (Orbix daemon port).
- oVaultError
- [out] - Details about the error.
- Returns:
- S_OK, E_FAIL, VAULT_E_CACHED
o offLine
-
Offline the related Vault Server.
- Parameters:
-
- iVaultServerAliasName
- [in] - Vault Server Alias Name.
- oVaultError
- [out] - Details about the error.
- Returns:
- S_OK, E_FAIL, VAULT_E_CACHED
o onLine
-
Online the related Vault Server.
- Parameters:
-
- iVaultServerName
- [in] - Vault Server Name (server marker).
- iVaultServerHost
- [in] - Vault Server Host.
- iVaultServerPort
- [in] - Vault Server Port (Orbix daemon port).
- oVaultError
- [out] - Details about the error.
- Returns:
- S_OK, E_FAIL, VAULT_E_CACHED
o onLine
-
Online the related Vault Server.
- Parameters:
-
- iVaultServerAliasName
- [in] - Vault Server Alias Name.
- oVaultError
- [out] - Details about the error.
- Returns:
- S_OK, E_FAIL, VAULT_E_CACHED
o prepare
-
Prepares all the work done during the UserSession.
- Parameters:
-
- oVaultError
- [out] - Details about the error.
- Returns:
- S_OK, E_FAIL.
o prepare
-
Prepares all the work done during the UserSession.
- Parameters:
-
- ibvContextOId
- [in] - CATlet context OId.
- oVaultError
- [out] - Details about the error.
- Returns:
- S_OK, E_FAIL.
o reloadProperties
-
Reload the whole set of properties on the related Vault Server.
- Parameters:
-
- iVaultServerName
- [in] - Vault Server Name (server marker).
- iVaultServerHost
- [in] - Vault Server Host.
- iVaultServerPort
- [in] - Vault Server Port (Orbix daemon port).
- oVaultError
- [out] - Details about the error.
- Returns:
- S_OK, E_FAIL, VAULT_E_CACHED
o reloadProperties
-
Reload the whole set of properties on the related Vault Server.
- Parameters:
-
- iVaultServerAliasName
- [in] - Vault Server Alias Name.
- oVaultError
- [out] - Details about the error.
- Returns:
- S_OK, E_FAIL, VAULT_E_CACHED
o removeUserSession
-
Removes a user session.
- Parameters:
-
- ipENOVIVaultUserSession
- [in] -
ENOVIVaultUserSession object to end.
- oVaultError
- [out] - Details about the error.
- Returns:
- S_OK, E_FAIL.
o removeUserSessionProxy
-
Removes a user session proxy.
- Parameters:
-
- ipENOVIVaultUserSession
- [in] -
ENOVIVaultUserSession object to end.
- oVaultError
- [out] - Details about the error.
- Returns:
- S_OK, E_FAIL.
o setVSTraceLevel
-
Sets the vault server trace level.
- Parameters:
-
- iVaultServerAliasName
- [in] - Vault Server Alias Name.
- int
- iTraceLevel [in] - the wanted vault server trace level
- int
- oPreviousTraceLevel [out] - the previous vault server trace level
- oVaultError
- [out] - Details about the error.
- Returns:
- S_OK, E_FAIL, VAULT_E_CACHED
o shutdown
-
Shutdown the related Vault Server.
- Parameters:
-
- iVaultServerName
- [in] - Vault Server Name (server marker).
- iVaultServerHost
- [in] - Vault Server Host.
- iVaultServerPort
- [in] - Vault Server Port (Orbix daemon port).
- iShutDownMode
- [in] - shutdown mode.
- oVaultError
- [out] - Details about the error.
- Returns:
- S_OK, E_FAIL, VAULT_E_CACHED
o shutdown
-
Shutdown the related Vault Server.
- Parameters:
-
- iVaultServerAliasName
- [in] - Vault Server Alias Name.
- iShutDownMode
- [in] - shutdown mode.
- oVaultError
- [out] - Details about the error.
- Returns:
- S_OK, E_FAIL, VAULT_E_CACHED
o unBindDocument
-
Unbinds a document.
Deletes the
ENOVIVaultDocument object on the client. Does not remove the actuel document on the server.
- Parameters:
-
- ipDocument
- [in] -
ENOVIVaultDocument object to unbind.
- oVaultError
- [out] - Details about the error.
- Returns:
- S_OK, E_FAIL.
o unPrepare
-
Unprepares all the work done during the UserSession.
- Parameters:
-
- oVaultError
- [out] - Details about the error.
- Returns:
- S_OK, E_FAIL.
o unPrepare
-
Unprepares all the work done during the UserSession.
- Parameters:
-
- ibvContextOId
- [in] - CATlet context OId.
- oVaultError
- [out] - Details about the error.
- Returns:
- S_OK, E_FAIL.
This object is included in the file: ENOVIVaultSession.h
If needed, your Imakefile.mk should include the module: ENOVIVaultClientAPP