|
|
|||||
| Package com.dassault_systemes.enovaultclientjava.vdk0vaultclient |
Interface ENOVIVaultUserSession
|
| Class Hierarchy |
com.dassault_systemes.enovaultclientjava.vdk0vaultclient.ENOVIVaultUserSession
| Class Location |
| Class Description |
public interface ENOVIVaultUserSession
This class supplies methods to transaction managment and documents factory.
| 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 |
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 Detail |
| Method Detail |
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)
iDocumentIdentifieriNameiDescriptioniMimeTypeiOriginalNameiOriginalPathiOriginalHost
public ENOVIVaultDocument createDocument(String iName, String iDescription, String iMimeType, String iOriginalName, String iOriginalPath, String iOriginalHost)
Creates a new document on Vault Server.
iNameiDescriptioniMimeTypeiOriginalNameiOriginalPathiOriginalHost
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.
iDocumentIdentifier
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.
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.
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.
ipDocument
public void setName(String iName)
Sets the Vault Session Name.
iSessionName
public void setReadProtocol(String iReadProtocol)
Sets the current read protocol.
iReadProtocol
public void setWriteProtocol(String iWriteProtocol)
Sets the current write protocol.
iWriteProtocol
public void unPrepare()
public void unPrepare(boolean ibvPropagate)