com.aspose.words

Class OdsoRecipientData

java.lang.Object

com.aspose.words.OdsoRecipientData

All Implemented Interfaces:

java.lang.Cloneable

public class OdsoRecipientData
extends java.lang.Object
implements java.lang.Cloneable

Represents information about a single record within an external data source that is to be excluded from the mail merge.

To learn more, visit the Mail Merge and Reporting documentation article.

Remarks:

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 getUniqueTag() / setUniqueTag(byte[]) property of this object to indicate this exclusion.

Method Summary

Modifier and Type	Method and Description
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.
protected java.lang.Object	memberwiseClone()
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.

Methods inherited from class java.lang.Object

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

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.

Returns:

The corresponding boolean value.

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.

Parameters:

value - The corresponding boolean value.

getColumn

public int getColumn()

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

Returns:

The corresponding int value.

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.

Parameters:

value - The corresponding int value.

getUniqueTag

public byte[] getUniqueTag()

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

Returns:

The corresponding byte[] value.

setUniqueTag

public void setUniqueTag(byte[] value)

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

Parameters:

value - The corresponding byte[] value.

getHash

public int getHash()

Represents the hash code for this record. Sometimes Microsoft Word uses getHash() / setHash(int) of a whole record instead of a getUniqueTag() / setUniqueTag(byte[]) value. The default value is 0.

Returns:

The corresponding int value.

setHash

public void setHash(int value)

Represents the hash code for this record. Sometimes Microsoft Word uses getHash() / setHash(int) of a whole record instead of a getUniqueTag() / setUniqueTag(byte[]) value. The default value is 0.

Parameters:

value - The corresponding int value.

memberwiseClone

protected java.lang.Object memberwiseClone()