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.

Field Summary
String NFS
String CORBA
String ClientReadProtocol
String ClientWriteProtocol
String ServerReadProtocol
String ServerWriteProtocol

Constructor Summary

Method Summary
void abort()
void abort(boolean ibvPropagate)
void prepare()
void prepare(boolean ibvPropagate)
void unPrepare()
void unPrepare(boolean ibvPropagate)
void commit()
void commit(boolean ibvPropagate)
ENOVIVaultDocument createDocument(byte[] iDocumentIdentifier, String iName, String iDescription, String iMimeType, String iOriginalName, String iOriginalPath, String iOriginalHost)
ENOVIVaultDocument createDocument(String iName, String iDescription, String iMimeType, String iOriginalName, String iOriginalPath, String iOriginalHost)
void removeDocument(ENOVIVaultDocument ipDocument)
ENOVIVaultDocument getDocument(byte[] iDocumentIdentifier)
ENOVIVaultDocument getDocument(byte[] iDocumentIdentifier, boolean ibvNoRefresh)
Enumeration getDocumentOIds()
Enumeration getReadSupportedProtocols()
Enumeration getWriteSupportedProtocols()
void setWriteProtocol(String iWriteProtocol)
void setReadProtocol(String iReadProtocol)
byte[] getOId()
byte[] getCATCtxtOId()
String getCurrentTimestamp()
String getVaultAliasName()
String getReadVaultName()
String getReadVaultHostName()
int getReadVaultListenerPort()
String getWriteVaultName()
String getWriteVaultHostName()
int getWriteVaultListenerPort()
boolean isTransMasterCallAllowed()
void allowTransMasterCall()
void disallowTransMasterCall()
void setName(String iName)
String getName()
Vector getDocsCacheInfo(Vector iOIdColl)


Field Detail

NFS

    String NFS


CORBA

    String CORBA


ClientReadProtocol

    String ClientReadProtocol


ClientWriteProtocol

    String ClientWriteProtocol


ServerReadProtocol

    String ServerReadProtocol


ServerWriteProtocol

    String ServerWriteProtocol


Constructor Detail

Method Detail

abort

    void abort()


abort

    void abort(boolean ibvPropagate)


prepare

    void prepare()


prepare

    void prepare(boolean ibvPropagate)


unPrepare

    void unPrepare()


unPrepare

    void unPrepare(boolean ibvPropagate)


commit

    void commit()


commit

    void commit(boolean ibvPropagate)


createDocument

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

Parameters:
iDocumentIdentifier
iName
iDescription
iMimeType
iOriginalName
iOriginalPath
iOriginalHost
Returns:
newly created IVaultDocument.

createDocument

    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
Returns:
newly created IVaultDocument.

removeDocument

    void removeDocument(ENOVIVaultDocument ipDocument)

Remove (delete) the supplied IVaultDocument.

Parameters:
ipDocument
IVaultDocument to remove.

getDocument

    ENOVIVaultDocument getDocument(byte[] iDocumentIdentifier)

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

Parameters:
iDocumentIdentifier
vault document identifier.
Returns:
vault document.

getDocument

    ENOVIVaultDocument getDocument(byte[] iDocumentIdentifier, boolean ibvNoRefresh)


getDocumentOIds

    Enumeration getDocumentOIds()

Returns:
enumeration of OIDs ( byte [] ).

getReadSupportedProtocols

    Enumeration getReadSupportedProtocols()

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

Returns:
collection of Read file transfert protocols.

getWriteSupportedProtocols

    Enumeration getWriteSupportedProtocols()

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

Returns:
collection of Write file transfert protocols.

setWriteProtocol

    void setWriteProtocol(String iWriteProtocol)

Sets the current write protocol.

Parameters:
iWriteProtocol
new current write protocol.

setReadProtocol

    void setReadProtocol(String iReadProtocol)

Sets the current read protocol.

Parameters:
iReadProtocol
new current read protocol.

getOId

    byte[] getOId()

Supplies the VaultUserSession Object Identifier.

Returns:
VaultUserSession Object Identifier.

getCATCtxtOId

    byte[] getCATCtxtOId()

Supplies the CATlet context Object Identifier.

Returns:
VaultUserSession Object Identifier.

getCurrentTimestamp

    String getCurrentTimestamp()

Supplies the current timestamp.

Returns:
the current timestamp.

getVaultAliasName

    String getVaultAliasName()

Supplies the Vault Server alias name.

Returns:
Vault Server alias name.

getReadVaultName

    String getReadVaultName()

Supplies the Vault Server name for Read.

Returns:
Vault Server name for Read.

getReadVaultHostName

    String getReadVaultHostName()

Supplies the Vault Server HostName for Read.

Returns:
Vault Server HostName for Read.

getReadVaultListenerPort

    int getReadVaultListenerPort()

Supplies the Vault Server listener port for Read.

Returns:
Vault Server listener port for Read.

getWriteVaultName

    String getWriteVaultName()

Supplies the Vault Server name for Write.

Returns:
Vault Server name for Write.

getWriteVaultHostName

    String getWriteVaultHostName()

Supplies the Vault Server HostName for Write.

Returns:
Vault Server HostName for Write.

getWriteVaultListenerPort

    int getWriteVaultListenerPort()

Supplies the Vault Server listener port for Write.

Returns:
Vault Server listener port for Write.

isTransMasterCallAllowed

    boolean isTransMasterCallAllowed()


allowTransMasterCall

    void allowTransMasterCall()


disallowTransMasterCall

    void disallowTransMasterCall()


setName

    void setName(String iName)

Sets the Vault Session Name.

Parameters:
iSessionName
Vault Session Name.

getName

    String getName()

Supplies the Vault Session Name.

Returns:
Vault Session Name.

getDocsCacheInfo

    Vector getDocsCacheInfo(Vector iOIdColl)

Returns an enumeration of VaultCacheInfo.



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