OdsoRecipientData
Inheritance: java.lang.Object
All Implemented Interfaces: java.lang.Cloneable
public class OdsoRecipientData implements 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.
Methods
| Method | Description |
|---|---|
| deepClone() | Returns a deep clone of this object. |
| getActive() | Specifies whether the record from the data source shall be imported into a document when the mail merge is performed. |
| getColumn() | Specifies the column within the data source that contains unique data for the current record. |
| getHash() | Represents the hash code for this record. |
| getUniqueTag() | Specifies the contents of a given record in the column containing unique data. |
| setActive(boolean value) | Specifies whether the record from the data source shall be imported into a document when the mail merge is performed. |
| setColumn(int value) | Specifies the column within the data source that contains unique data for the current record. |
| setHash(int value) | Represents the hash code for this record. |
| setUniqueTag(byte[] value) | Specifies the contents of a given record in the column containing unique data. |
deepClone()
public OdsoRecipientData deepClone()
Returns a deep clone of this object.
Returns: OdsoRecipientData
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: boolean - 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: int - The corresponding int 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: int - 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: byte[] - The corresponding byte[] value.
setActive(boolean value)
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:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The corresponding boolean value. |
setColumn(int value)
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:
| Parameter | Type | Description |
|---|---|---|
| value | int | The corresponding int value. |
setHash(int value)
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:
| Parameter | Type | Description |
|---|---|---|
| value | int | The corresponding int value. |
setUniqueTag(byte[] value)
public void setUniqueTag(byte[] value)
Specifies the contents of a given record in the column containing unique data. The default value is null .
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | byte[] | The corresponding byte[] value. |
