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