Package de.elo.ix.client.devents

Class UpDownloadEventInfo

java.lang.Object

byps.BValueClass

de.elo.ix.client.ValueClass

de.elo.ix.client.devents.UpDownloadEventInfo

All Implemented Interfaces:

Serializable

public class UpDownloadEventInfo
extends ValueClass

This class describes a document stream (version, attachment, preview, fulltext, signature) being uploaded or downloaded in an event of DocumentEvents.

Since:

12.02.002.002

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected int	docId	Document version ID.
protected UpDownloadKind	kind	Kind of document related stream.
protected long	length	Number of bytes to download from a document related stream.
protected long	offset	Document related stream should be downloaded starting at this position.
protected boolean	preliminaryTest	A preliminary test for a later uploaded stream.
protected Sord	sord	Sord object.
protected UpDownloadUsage	usage	From where an event is called.

Fields inherited from class byps.BValueClass

bypsClient, changedMembers, dbHelper, FLAG_SEALED, flags

Constructor Summary

Constructors

Constructor	Description
UpDownloadEventInfo()
UpDownloadEventInfo(UpDownloadEventInfo rhs)

Method Summary

Modifier and Type	Method	Description
int	getDocId()
UpDownloadKind	getKind()
long	getLength()
long	getOffset()
Sord	getSord()
UpDownloadUsage	getUsage()
boolean	isPreliminaryTest()
void	setDocId(int docId)
void	setKind(UpDownloadKind kind)
void	setLength(long length)
void	setOffset(long offset)
void	setPreliminaryTest(boolean onlyTest)
void	setSord(Sord sord)
void	setUsage(UpDownloadUsage usage)
String	toString()

Methods inherited from class byps.BValueClass

getBypsClient, getChangedMembers, getDbHelper, isChangedMember, isSealed, seal, seal, setBypsClient, setChangedMember, setChangedMembers, setDbHelper

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

kind

protected UpDownloadKind kind

Kind of document related stream.

usage

protected UpDownloadUsage usage

From where an event is called.

sord

protected Sord sord

Sord object. Check BValueClass.getChangedMembers() to find out, which members of the Sord object are valid. Usually, only Sord.getId() is set. This member is null, if the client application uses IXServicePortIF.checkinDocBegin(de.elo.ix.client.ClientInfo, de.elo.ix.client.Document) to prepare a document upload.

docId

protected int docId

Document version ID. Only valid for DocumentEvents.beginDownload(de.elo.ix.client.IXServerEventsContext, UpDownloadEventInfo).

offset

protected long offset

Document related stream should be downloaded starting at this position. Only valid for DocumentEvents.beginDownload(de.elo.ix.client.IXServerEventsContext, UpDownloadEventInfo). If the entire stream should be read, offset is 0 and length is -1.

length

protected long length

Number of bytes to download from a document related stream. Only valid for DocumentEvents.beginDownload(de.elo.ix.client.IXServerEventsContext, UpDownloadEventInfo). If this element is -1, read up to the end of the stream. If the entire stream should be read, offset is 0 and length is -1.

preliminaryTest

protected boolean preliminaryTest

A preliminary test for a later uploaded stream. While uploading a content stream for a new document via IXConnectionIF.upload(String, java.io.File) to the server, the related Sord object is unknown. So the information that usually controls, whether a document processor shall handle the stream is unavailable. To solve this situation, the uploaded stream is stored temporarily and the actual upload is deferred to the function IXServicePortIF.checkinDocEnd(de.elo.ix.client.ClientInfo, de.elo.ix.client.Sord, de.elo.ix.client.SordZ, de.elo.ix.client.Document, de.elo.ix.client.LockZ). In order to know whether a stream should be temporarily stored, function IXServicePortIF.checkinDocBegin2(de.elo.ix.client.ClientInfo, de.elo.ix.client.Sord, de.elo.ix.client.Document, de.elo.ix.client.CheckinDocOptions) calls the event DocumentEvents.beginUpload(de.elo.ix.client.IXServerEventsContext, de.elo.ix.client.devents.UpDownloadEventInfo). The returned document processor is only checked to be non-null but is never invoked. The document processor used to process the stream is requested in IXServicePortIF.checkinDocEnd(de.elo.ix.client.ClientInfo, de.elo.ix.client.Sord, de.elo.ix.client.SordZ, de.elo.ix.client.Document, de.elo.ix.client.LockZ).

Constructor Details

UpDownloadEventInfo

public UpDownloadEventInfo()

UpDownloadEventInfo

public UpDownloadEventInfo(UpDownloadEventInfo rhs)

Method Details

getDocId

public int getDocId()

setDocId

public void setDocId(int docId)

getUsage

public UpDownloadUsage getUsage()

setUsage

public void setUsage(UpDownloadUsage usage)

getSord

public Sord getSord()

setSord

public void setSord(Sord sord)

getOffset

public long getOffset()

setOffset

public void setOffset(long offset)

getLength

public long getLength()

setLength

public void setLength(long length)

isPreliminaryTest

public boolean isPreliminaryTest()

setPreliminaryTest

public void setPreliminaryTest(boolean onlyTest)

getKind

public UpDownloadKind getKind()

setKind

public void setKind(UpDownloadKind kind)

toString

public String toString()

Overrides:

toString in class Object