com.spire.doc
Class OdsoRecipientData

java.lang.Object
  com.spire.doc.OdsoRecipientData

public class OdsoRecipientData
extends java.lang.Object

Represents information about a single record within an external data source that is to be excluded from the mail merge. If a record shall be merged into a merged document, then no information is needed about that record. However, if a given record shall not be merged into a merged document, then the value of the unique key for that record shall be stored in the property of this object to indicate this exclusion.

Constructor Summary

OdsoRecipientData()

Method Summary

OdsoRecipientData	deepClone() Returns a deep clone of this object.
boolean	getActive() Specifies whether the record from the data source shall be imported into a document when the mail merge is performed.
int	getColumn() Specifies the column within the data source that contains unique data for the current record.
int	getHash() Represents the hash code for this record.
byte[]	getUniqueTag() Specifies the contents of a given record in the column containing unique data.
void	setActive(boolean value) Specifies whether the record from the data source shall be imported into a document when the mail merge is performed.
void	setColumn(int value) Specifies the column within the data source that contains unique data for the current record.
void	setHash(int value) Represents the hash code for this record.
void	setUniqueTag(byte[] value) Specifies the contents of a given record in the column containing unique data.

Constructor Detail

OdsoRecipientData

public OdsoRecipientData()

Method Detail

deepClone

public OdsoRecipientData deepClone()

Returns a deep clone of this object.

getActive

public boolean getActive()

Specifies whether the record from the data source shall be imported into a document when the mail merge is performed. The default value is true.

setActive

public void setActive(boolean value)

Specifies whether the record from the data source shall be imported into a document when the mail merge is performed. The default value is true.

getColumn

public int getColumn()

Specifies the column within the data source that contains unique data for the current record. The default value is 0.

setColumn

public void setColumn(int value)

Specifies the column within the data source that contains unique data for the current record. The default value is 0.

getUniqueTag

public byte[] getUniqueTag()

Specifies the contents of a given record in the column containing unique data. The default value is null.

setUniqueTag

public void setUniqueTag(byte[] value)

Specifies the contents of a given record in the column containing unique data. The default value is null.

getHash

public int getHash()

Represents the hash code for this record. Sometimes Microsoft Word uses of a whole record instead of a value. The default value is 0.

setHash

public void setHash(int value)

Represents the hash code for this record. Sometimes Microsoft Word uses of a whole record instead of a value. The default value is 0.