Package com.dassault_systemes.enovaultclientjava.vdk0vaultclient

   
Interface ENOVIVaultUserSession

 
Class Hierarchy
com.dassault_systemes.enovaultclientjava.vdk0vaultclient.ENOVIVaultUserSession
Class Location

Framework : ENOVaultClientJAVA

Module : VDK0VaultClient

Class Description

public interface ENOVIVaultUserSession

This class supplies methods to transaction managment and documents factory.

Version:
V5R11
Field Summary
public static final String ClientReadProtocol
public static final String ClientWriteProtocol
public static final String CORBA
public static final String NFS
public static final String ServerReadProtocol
public static final String ServerWriteProtocol

Constructor Summary

Method Summary
public void abort()
public void abort(boolean ibvPropagate)
public void allowTransMasterCall()
public void commit()
public void commit(boolean ibvPropagate)
public ENOVIVaultDocument createDocument(byte[] iDocumentIdentifier, String iName, String iDescription, String iMimeType, String iOriginalName, String iOriginalPath, String iOriginalHost)
public ENOVIVaultDocument createDocument(String iName, String iDescription, String iMimeType, String iOriginalName, String iOriginalPath, String iOriginalHost)
Creates a new document on Vault Server.
public void disallowTransMasterCall()
public byte[] getCATCtxtOId()
Supplies the CATlet context Object Identifier.
public String getCurrentTimestamp()
Supplies the current timestamp.
public Vector getDocsCacheInfo(Vector iOIdColl)
Returns an enumeration of VaultCacheInfo.
public ENOVIVaultDocument getDocument(byte[] iDocumentIdentifier)
Get the document on Vault server pertainning to the supplied Id.
public ENOVIVaultDocument getDocument(byte[] iDocumentIdentifier, boolean ibvNoRefresh)
public Enumeration getDocumentOIds()
public String getName()
Supplies the Vault Session Name.
public byte[] getOId()
Supplies the VaultUserSession Object Identifier.
public Enumeration getReadSupportedProtocols()
Supplies the collection of supported file transfert protocols.
must be call between open and read
public String getReadVaultHostName()
Supplies the Vault Server HostName for Read.
public int getReadVaultListenerPort()
Supplies the Vault Server listener port for Read.
public String getReadVaultName()
Supplies the Vault Server name for Read.
public String getVaultAliasName()
Supplies the Vault Server alias name.
public Enumeration getWriteSupportedProtocols()
Supplies the collection of supported file transfert protocols.
must be call between open and write
public String getWriteVaultHostName()
Supplies the Vault Server HostName for Write.
public int getWriteVaultListenerPort()
Supplies the Vault Server listener port for Write.
public String getWriteVaultName()
Supplies the Vault Server name for Write.
public boolean isTransMasterCallAllowed()
public void prepare()
public void prepare(boolean ibvPropagate)
public void removeDocument(ENOVIVaultDocument ipDocument)
Remove (delete) the supplied IVaultDocument.
public void setName(String iName)
Sets the Vault Session Name.
public void setReadProtocol(String iReadProtocol)
Sets the current read protocol.
public void setWriteProtocol(String iWriteProtocol)
Sets the current write protocol.
public void unPrepare()
public void unPrepare(boolean ibvPropagate)


Field Detail

ClientReadProtocol

    public static final String ClientReadProtocol


ClientWriteProtocol

    public static final String ClientWriteProtocol


CORBA

    public static final String CORBA


NFS

    public static final String NFS


ServerReadProtocol

    public static final String ServerReadProtocol


ServerWriteProtocol

    public static final String ServerWriteProtocol


Constructor Detail

Method Detail

abort

    public void abort()

Throws:
ENOVIVaultError -

abort

    public void abort(boolean ibvPropagate)


allowTransMasterCall

    public void allowTransMasterCall()


commit

    public void commit()

Throws:
ENOVIVaultError -

commit

    public void commit(boolean ibvPropagate)


createDocument

    public ENOVIVaultDocument createDocument(byte[] iDocumentIdentifier, String iName, String iDescription, String iMimeType, String iOriginalName, String iOriginalPath, String iOriginalHost)

Parameters:
iDocumentIdentifier
iName
iDescription
iMimeType
iOriginalName
iOriginalPath
iOriginalHost
Return:
newly created IVaultDocument.
Throws:
ENOVIVaultError -
Since:
V5R8

createDocument

    public ENOVIVaultDocument createDocument(String iName, String iDescription, String iMimeType, String iOriginalName, String iOriginalPath, String iOriginalHost)

Creates a new document on Vault Server.

Parameters:
iName
iDescription
iMimeType
iOriginalName
iOriginalPath
iOriginalHost
Return:
newly created IVaultDocument.
Throws:
ENOVIVaultError -
Since:
V5R7

disallowTransMasterCall

    public void disallowTransMasterCall()


getCATCtxtOId

    public byte[] getCATCtxtOId()

Supplies the CATlet context Object Identifier.

Return:
VaultUserSession Object Identifier.
Since:
V5R11

getCurrentTimestamp

    public String getCurrentTimestamp()

Supplies the current timestamp.

Return:
the current timestamp.
Since:
V5R8

getDocsCacheInfo

    public Vector getDocsCacheInfo(Vector iOIdColl)

Returns an enumeration of VaultCacheInfo.


getDocument

    public ENOVIVaultDocument getDocument(byte[] iDocumentIdentifier)

Get the document on Vault server pertainning to the supplied Id.

Parameters:
iDocumentIdentifier
vault document identifier.
Return:
vault document.
Throws:
ENOVIVaultError -
Since:
V5R7

getDocument

    public ENOVIVaultDocument getDocument(byte[] iDocumentIdentifier, boolean ibvNoRefresh)


getDocumentOIds

    public Enumeration getDocumentOIds()

Return:
enumeration of OIDs ( byte [] ).
Since:
V5R7

getName

    public String getName()

Supplies the Vault Session Name.

Return:
Vault Session Name.
Since:
V5R11

getOId

    public byte[] getOId()

Supplies the VaultUserSession Object Identifier.

Return:
VaultUserSession Object Identifier.
Since:
V5R7

getReadSupportedProtocols

    public Enumeration getReadSupportedProtocols()

Supplies the collection of supported file transfert protocols.
must be call between open and read

Return:
collection of Read file transfert protocols.
Throws:
ENOVIVaultError -
Since:
V5R7

getReadVaultHostName

    public String getReadVaultHostName()

Supplies the Vault Server HostName for Read.

Return:
Vault Server HostName for Read.
Since:
V5R9

getReadVaultListenerPort

    public int getReadVaultListenerPort()

Supplies the Vault Server listener port for Read.

Return:
Vault Server listener port for Read.
Since:
V5R9

getReadVaultName

    public String getReadVaultName()

Supplies the Vault Server name for Read.

Return:
Vault Server name for Read.
Since:
V5R9

getVaultAliasName

    public String getVaultAliasName()

Supplies the Vault Server alias name.

Return:
Vault Server alias name.
Since:
V5R9

getWriteSupportedProtocols

    public Enumeration getWriteSupportedProtocols()

Supplies the collection of supported file transfert protocols.
must be call between open and write

Return:
collection of Write file transfert protocols.
Throws:
ENOVIVaultError -
Since:
V5R7

getWriteVaultHostName

    public String getWriteVaultHostName()

Supplies the Vault Server HostName for Write.

Return:
Vault Server HostName for Write.
Since:
V5R9

getWriteVaultListenerPort

    public int getWriteVaultListenerPort()

Supplies the Vault Server listener port for Write.

Return:
Vault Server listener port for Write.
Since:
V5R9

getWriteVaultName

    public String getWriteVaultName()

Supplies the Vault Server name for Write.

Return:
Vault Server name for Write.
Since:
V5R9

isTransMasterCallAllowed

    public boolean isTransMasterCallAllowed()


prepare

    public void prepare()

Throws:
ENOVIVaultError -

prepare

    public void prepare(boolean ibvPropagate)


removeDocument

    public void removeDocument(ENOVIVaultDocument ipDocument)

Remove (delete) the supplied IVaultDocument.

Parameters:
ipDocument
IVaultDocument to remove.
Throws:
ENOVIVaultError -
Since:
V5R7

setName

    public void setName(String iName)

Sets the Vault Session Name.

Parameters:
iSessionName
Vault Session Name.
Since:
V5R11

setReadProtocol

    public void setReadProtocol(String iReadProtocol)

Sets the current read protocol.

Parameters:
iReadProtocol
new current read protocol.
Throws:
ENOVIVaultError -
Since:
V5R7

setWriteProtocol

    public void setWriteProtocol(String iWriteProtocol)

Sets the current write protocol.

Parameters:
iWriteProtocol
new current write protocol.
Throws:
ENOVIVaultError -
Since:
V5R7

unPrepare

    public void unPrepare()

Throws:
ENOVIVaultError -

unPrepare

    public void unPrepare(boolean ibvPropagate)



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