|
|
Package com.dassault_systemes.enovaultclientjava.vdk0vaultclient |
Interface ENOVIVaultDocument
|
Class Hierarchy |
com.dassault_systemes.enovaultclientjava.vdk0vaultclient.ENOVIVaultDocument
Class Location |
Class Description |
public interface ENOVIVaultDocument
This interfaces supplies methods to manage documents.
Field Summary |
int | CREATED |
int | UPDATED |
int | DELETED |
int | COMMITTED |
int | EXCLUSIVELOCK |
Constructor Summary |
Method Summary |
byte[] | getOId() |
byte[] | getEXTOId() |
void | setEXTOId(byte[] iEXTOId) |
byte[] | getURL() |
ENOVIVaultUserSession | getFatherUserSession() |
int | getStatus() |
ENOVIDocMandAttHolder | getMandAttr() |
String | getCreationTimestamp() |
VaultDocCreatLastModTimestampHolder | getGMTCreatLastModTimestamp() |
String | getLastModTimestamp() |
long | getGMTLastModTimestamp() |
String | getName() |
String | getDescription() |
int | getSize() |
long | getCKSum() |
String | getMimeType() |
void | setName(String iName) |
void | setDescription(String iDescription) |
void | setMimeType(String iMimetype) |
String | getOriginalName() |
String | getOriginalPath() |
String | getOriginalHost() |
void | setOriginalName(String iOriginalName) |
void | setOriginalPath(String iOriginalPath) |
void | setOriginalHost(String iOriginalHost) |
void | openRead() |
void | openRead(boolean ibvNoRefresh) |
void | openWrite(int iDocSize, boolean iFullDocWritePlanned) |
void | openWrite(int iDocSize, boolean iFullDocWritePlanned, String isvAliasName, String isvServiceName, String isvHostName, int invListenPort) |
void | openReadWrite(boolean iFullDocWritePlanned) |
int | getCurPos() |
void | setCurPos(int iNewCurPos) |
int | readBlock(byte[] dataBuffer, int off, int len) |
int | readBlock(byte[] dataBuffer, int off, int len, boolean ibvNoRefresh) |
void | copyToLocalFile(String iLocalFullPathName, boolean iDeleteLocalFileAtClose) |
void | copyToLocalFile(String iLocalFullPathName, boolean iDeleteLocalFileAtClose, boolean ibvNoRefresh) |
int | read(byte[] ReadBuffer) |
void | writeBlock(byte[] iBufferToWrite, int off, int len) |
void | copyFromLocalFile(String iLocalFullPathName, boolean iDeleteLocalFileAtClose) |
void | copyDocValueFromDoc(ENOVIVaultDocument origin) |
void | write(byte[] iBufferToWrite) |
String | getLocationPath() |
void | close() |
void | close(boolean ibvNoRefresh) |
void | close(boolean ibvNoRefresh, boolean ibvResetLockStatus) |
void | close(int invDocSize) |
boolean | isCached() |
void | refresh() |
int | getBlockSize() |
Field Detail |
int CREATED
int UPDATED
int DELETED
int COMMITTED
int EXCLUSIVELOCK
Constructor Detail |
Method Detail |
byte[] getOId()
byte[] getEXTOId()Supplies the IVaultDocument External Object Identifier.
void setEXTOId(byte[] iEXTOId)Sets the IVaultDocument External Object Identifier.
byte[] getURL()Supplies the IVaultDocument Unique Universal Identifier.
ENOVIVaultUserSession getFatherUserSession()Gets the Father ENOVIVaultUserSession.
int getStatus()Supplies the IVaultDocument status.
ENOVIDocMandAttHolder getMandAttr()
String getCreationTimestamp()Supplies the IVaultDocument creation Date.
VaultDocCreatLastModTimestampHolder getGMTCreatLastModTimestamp()Supplies the VaultDocument creation Date in milli second GMT time.
String getLastModTimestamp()Supplies the IVaultDocument last modification Date.
long getGMTLastModTimestamp()Supplies the VaultDocument last modification Date in milli second GMT time.
oGMTLastTimestamp
String getName()Supplies the IVaultDocument name.
String getDescription()Supplies the IVaultDocument description.
int getSize()Supplies the IVaultDocument size.
long getCKSum()Supplies the VaultDocument cksum.
oDescription
String getMimeType()Supplies the IVaultDocument mimetype.
void setName(String iName)Sets the IVaultDocument name.
iName
void setDescription(String iDescription)Sets the IVaultDocument description.
void setMimeType(String iMimetype)Sets the IVaultDocument mimetype.
iMimetype
String getOriginalName()Supplies the IVaultDocument OriginalName.
String getOriginalPath()Supplies the IVaultDocument OriginalPath.
String getOriginalHost()Supplies the IVaultDocument OriginalHost.
void setOriginalName(String iOriginalName)Sets the IVaultDocument OriginalName.
iOriginalName
void setOriginalPath(String iOriginalPath)Sets the IVaultDocument OriginalPath.
iOriginalPath
void setOriginalHost(String iOriginalHost)Sets the IVaultDocument OriginalHost.
iOriginalHost
void openRead()Initiate a document read operation. It give access to the last committed view. At open time
void openRead(boolean ibvNoRefresh)
void openWrite(int iDocSize, boolean iFullDocWritePlanned)Initiate a document write operation. To be successful, it supposes that the IVaultDocument
iDocSize
iFullDocWritePlanned
void openWrite(int iDocSize, boolean iFullDocWritePlanned, String isvAliasName, String isvServiceName, String isvHostName, int invListenPort)
void openReadWrite(boolean iFullDocWritePlanned)Initiate a document read write operation. To be successful, it supposes that the IVault document
Deprecated.
iFullDocWritePlanned
int getCurPos()Supplies the current position in the document you are accessing. It supposes the document
void setCurPos(int iNewCurPos)Sets the current position in the document you are accessing. It supposes the document
iNewCurPos
int readBlock(byte[] dataBuffer, int off, int len)Reads a data block beginning at the current position from the server document
byte
int readBlock(byte[] dataBuffer, int off, int len, boolean ibvNoRefresh)
void copyToLocalFile(String iLocalFullPathName, boolean iDeleteLocalFileAtClose)Copies the server document into a local file. The local file full path name is not mandatory.
iLocalFullPathName
iDeleteLocalFileAtClose
void copyToLocalFile(String iLocalFullPathName, boolean iDeleteLocalFileAtClose, boolean ibvNoRefresh)
int read(byte[] ReadBuffer)Reads the whole server document into a bytes array. The current position is set to the document
allocated
void writeBlock(byte[] iBufferToWrite, int off, int len)Write a data block on server beginning at the current position from a bytes array. The current
iBufferToWrite
void copyFromLocalFile(String iLocalFullPathName, boolean iDeleteLocalFileAtClose)Copies the local document on server. The local file full path name is mandatory. The current position
iLocalFullPathName
iDeleteLocalFileAtClose
void copyDocValueFromDoc(ENOVIVaultDocument origin)
void write(byte[] iBufferToWrite)Write the whole document on server from a bytes array. The current position is set to the document end.
iBufferToWrite
String getLocationPath()Supplies when possible and according to transfer protocols, the full path name of the IVault document.
void close()Ends the Read, Write or ReadWrite sequence. Reset the current position to the document beginning.
void close(boolean ibvNoRefresh)
void close(boolean ibvNoRefresh, boolean ibvResetLockStatus)
void close(int invDocSize)
boolean isCached()Specifies if the document is cached or not.
void refresh()Refresh this document if it is a cached document and it is not up-to-date.
int getBlockSize()Supplies the Block size.