de.bea.domingo
Interface DItem

All Superinterfaces:

DBase, DBaseItem, java.io.Serializable

All Known Implementing Classes:

ItemHttp, ItemProxy, MockItem

public interface DItem
extends DBaseItem

Represents a discrete value or set of values in a document.

The client interface displays items in a document through fields on a form. When a field on a form and an item in a document have the same name, the field displays the item (for example, the Subject field displays the Subject item).

All items in a document are accessible programmatically, regardless of what form is used to display the document in the user interface.

Author:

Marcus Toennis

Field Summary

static int	ACTIONCD item type.
static int	ASSISTANTINFO item type.
static int	ATTACHMENT item type.
static int	AUTHORS item type.
static int	COLLATION item type.
static int	DATETIMES item type.
static int	EMBEDDEDOBJECT item type.
static int	ERRORITEM item type.
static int	FORMULA item type.
static int	HTML item type.
static int	ICON item type.
static int	LSOBJECT item type.
static int	MIME_PART item type.
static int	NAMES item type.
static int	NOTELINKS item type.
static int	NOTEREFS item type.
static int	NUMBERS item type.
static int	OTHEROBJECT item type.
static int	QUERYCD item type.
static int	READERS item type.
static int	RICHTEXT item type.
static int	SIGNATURE item type.
static int	TEXT item type.
static int	UNAVAILABLE item type.
static int	UNKNOWN item type.
static int	USERDATA item type.
static int	USERID item type.
static int	VIEWMAPDATA item type.
static int	VIEWMAPLAYOUT item type.

Method Summary

java.lang.String	abstractText(int maxlen, boolean dropVowels, boolean userDict) Abbreviates the contents of a text item.
void	appendToTextList(java.util.List values) For an item that's a text list, adds a new value to the item without erasing any existing values.
void	appendToTextList(java.lang.String value) For an item that's a text list, adds a new value to the item without erasing any existing values.
boolean	containsValue(java.util.Calendar value) Checks whether a value matches at least one of an item's values.
boolean	containsValue(double value) Checks whether a value matches at least one of an item's values.
boolean	containsValue(java.lang.Double value) Checks whether a value matches at least one of an item's values.
boolean	containsValue(int value) Checks whether a value matches at least one of an item's values.
boolean	containsValue(java.lang.Integer value) Checks whether a value matches at least one of an item's values.
boolean	containsValue(java.lang.String value) Checks whether a value matches at least one of an item's values.
DItem	copyItemToDocument(DDocument document) Copies an item to a specified document.
DItem	copyItemToDocument(DDocument document, java.lang.String newName) Copies an item to a specified document.
java.io.InputStream	getInputStream() InputStream representation of the contents of an EmbeddedObject, Item, or MIMEEntity object.
java.util.Calendar	getLastModified() The date that an item was last modified.
java.io.Reader	getReader() Contents of an EmbeddedObject, Item, or MIMEEntity object in the form of a java.io.Reader object.
int	getSize() Returns the number of values in a item.
java.lang.String	getText() A plain text representation of an item's value.
java.lang.String	getText(int maxLen) A plain text representation of an item's value.
int	getType() The data type of an item.
java.lang.Object	getValueCustomData() Returns as an object the value of an item containing custom data.
java.lang.Object	getValueCustomData(java.lang.String type) Returns as an object the value of an item containing custom data.
byte[]	getValueCustomDataBytes(java.lang.String type) Returns as a byte array the value of an item containing custom data.
DDateRange	getValueDateRange() Returns the value of an item with two Calendar value, a date range.
java.util.Calendar	getValueDateTime() Returns the value of an item with a single Calendar value.
java.lang.Double	getValueDouble() Returns the value of an item with a single double value.
java.lang.Integer	getValueInteger() Returns the value of an item with a single int value.
int	getValueLength() The bytes of internal storage, including overhead, required to store an item.
java.util.List	getValues() Returns the value of an item.
java.lang.String	getValueString() Returns the value of an item with a single text value.
boolean	isAuthors() Indicates whether an item is of type Authors.
boolean	isEncrypted() Indicates whether an item is encrypted.
boolean	isNames() Indicates whether an item is of type Names.
boolean	isProtected() Indicates whether a user needs at least Editor access to modify an item.
boolean	isReaders() Indicates whether an item is of type Readers.
boolean	isSaveToDisk() Indicates whether an item is saved when the document is saved.
boolean	isSigned() Indicates whether a document contains a signature.
boolean	isSummary() Indicates whether an item contains summary or non-summary data.
void	setAuthors(boolean flag) Indicates whether an item is of type Authors.
void	setEncrypted(boolean flag) Indicates whether an item is encrypted.
void	setNames(boolean flag) Indicates whether an item is of type Names.
void	setProtected(boolean flag) Indicates whether a user needs at least Editor access to modify an item.
void	setReaders(boolean flag) Indicates whether an item is of type Readers.
void	setSaveToDisk(boolean flag) Indicates whether an item is saved when the document is saved.
void	setSigned(boolean flag) Indicates whether an item contains a signature the next time the document is signed.
void	setSummary(boolean flag) Indicates whether an item contains summary or non-summary data.
void	setValueCustomData(java.lang.Object obj) Sets the value of an item to custom data from an object.
void	setValueCustomData(java.lang.String type, java.lang.Object obj) Sets the value of an item to custom data from an object.
void	setValueCustomDataBytes(java.lang.String type, byte[] bytes) Sets the value of an item to custom data from a byte array.
void	setValueDateRange(java.util.Calendar calendar1, java.util.Calendar calendar2) Sets the value of an item to a date range.
void	setValueDateRange(DDateRange dateRange) Sets the value of an item to a date range.
void	setValueDateTime(java.util.Calendar calendar) Sets the value of an item to a single datetime value.
void	setValueDateTime(java.util.TimeZone timezone) Sets the value of an item to a single time zone value.
void	setValueDouble(double d) Sets the value of an item to a single numeric value.
void	setValueDouble(java.lang.Double d) Sets the value of an item to a single numeric value.
void	setValueInteger(int i) Sets the value of an item to a single numeric value.
void	setValueInteger(java.lang.Integer i) Sets the value of an item to a single numeric value.
void	setValues(java.util.List values) Sets the value of an item.
void	setValueString(java.lang.String value) Sets the value of an item to a single string value.

Methods inherited from interface de.bea.domingo.DBaseItem

getName, remove

Methods inherited from interface de.bea.domingo.DBase

equals, hashCode, toString

Field Detail

UNKNOWN

static final int UNKNOWN

item type.

See Also:

Constant Field Values

RICHTEXT

static final int RICHTEXT

item type.

See Also:

Constant Field Values

COLLATION

static final int COLLATION

item type.

See Also:

Constant Field Values

NOTEREFS

static final int NOTEREFS

item type.

See Also:

Constant Field Values

ICON

static final int ICON

item type.

See Also:

Constant Field Values

NOTELINKS

static final int NOTELINKS

item type.

See Also:

Constant Field Values

SIGNATURE

static final int SIGNATURE

item type.

See Also:

Constant Field Values

USERDATA

static final int USERDATA

item type.

See Also:

Constant Field Values

QUERYCD

static final int QUERYCD

item type.

See Also:

Constant Field Values

ACTIONCD

static final int ACTIONCD

item type.

See Also:

Constant Field Values

ASSISTANTINFO

static final int ASSISTANTINFO

item type.

See Also:

Constant Field Values

VIEWMAPDATA

static final int VIEWMAPDATA

item type.

See Also:

Constant Field Values

VIEWMAPLAYOUT

static final int VIEWMAPLAYOUT

item type.

See Also:

Constant Field Values

LSOBJECT

static final int LSOBJECT

item type.

See Also:

Constant Field Values

HTML

static final int HTML

item type.

See Also:

Constant Field Values

MIME_PART

static final int MIME_PART

item type.

See Also:

Constant Field Values

ERRORITEM

static final int ERRORITEM

item type.

See Also:

Constant Field Values

UNAVAILABLE

static final int UNAVAILABLE

item type.

See Also:

Constant Field Values

NUMBERS

static final int NUMBERS

item type.

See Also:

Constant Field Values

DATETIMES

static final int DATETIMES

item type.

See Also:

Constant Field Values

NAMES

static final int NAMES

item type.

See Also:

Constant Field Values

READERS

static final int READERS

item type.

See Also:

Constant Field Values

AUTHORS

static final int AUTHORS

item type.

See Also:

Constant Field Values

ATTACHMENT

static final int ATTACHMENT

item type.

See Also:

Constant Field Values

OTHEROBJECT

static final int OTHEROBJECT

item type.

See Also:

Constant Field Values

EMBEDDEDOBJECT

static final int EMBEDDEDOBJECT

item type.

See Also:

Constant Field Values

TEXT

static final int TEXT

item type.

See Also:

Constant Field Values

FORMULA

static final int FORMULA

item type.

See Also:

Constant Field Values

USERID

static final int USERID

item type.

See Also:

Constant Field Values

Method Detail

getValues

java.util.List getValues()

Returns the value of an item.

If multiple items have the same name, this method returns the value of the first item. Use the Items property to get all the items.

If the item has no value, this method returns an empty vector.

If no item with the specified name exists, this method returns an empty vector. It does not throw an exception. Use hasItem to verify the existence of an item.

This property returns the same value(s) for an item as getValues in Item.

Returns:

The value or values contained in the item. The data type of the value depends on the data type of the item.

setValues

void setValues(java.util.List values)

Sets the value of an item.

The value of an item in general is a list of values.

Legal types for the list elements are:

• java.util.Calendar
• java.util.Integer
• java.util.Double
• java.util.String

Parameters:

values - the values

getValueString

java.lang.String getValueString()

Returns the value of an item with a single text value.

If multiple items have the same name, this method returns the value of the first item. Use the Items property to get all the items.

The value of the item cannot be null, but if the value is numeric or Calendar, this method returns an empty String.

If no item with the specified name exists, this method returns null. It does not throw an exception. Use hasItem to verify the existence of an item.

If the item has multiple values, this method returns the first value.

Returns:

The value of the item as a String.

getValueInteger

java.lang.Integer getValueInteger()

Returns the value of an item with a single int value.

If multiple items have the same name, this method returns the value of the first item. Use the Items property to get all the items.

If the value is text and is empty, this method returns null.

If the value is text and cannot be converted to an integer, this method returns null.

If no item with the specified name exists, this method returns null. It does not throw an exception. Use hasItem to verify the existence of an item.

If the item has multiple values, this method returns the first value.

A decimal number is rounded down if the fraction is less than 0.5 and up if the fraction is 0.5 or greater.

Returns:

The value of the item, rounded to the nearest integer or null

getValueDouble

java.lang.Double getValueDouble()

Returns the value of an item with a single double value.

If multiple items have the same name, this method returns the value of the first item. Use the Items property to get all the items.

If the value is text and is empty, this method returns null.

If the value is text and cannot be converted to a double, this method returns null.

If no item with the specified name exists, this method returns null. It does not throw an exception. Use hasItem to verify the existence of an item.

If the item has multiple values, this method returns the first value.

A decimal number is rounded down if the fraction is less than 0.5 and up if the fraction is 0.5 or greater.

Returns:

The value of the item, rounded to the nearest integer or null

getValueDateTime

java.util.Calendar getValueDateTime()

Returns the value of an item with a single Calendar value. The date/time value of the item is stored in the calendar in the default time zone of the client.

If multiple items have the same name, this method returns the value of the first item. Use the Items property to get all the items.

If value is numeric or text, this method returns null.

If no item with the specified name exists, this method returns null. It does not throw an exception. Use hasItem to verify the existence of an item.

If the item has multiple values, this method returns the first value.

Returns:

The value of the item as a Calendar or null if the item doesn't contain a date/time value

getValueDateRange

DDateRange getValueDateRange()

Returns the value of an item with two Calendar value, a date range.

If multiple items have the same name, this method returns the value of the first item. Use the Items property to get all the items.

If value is numeric or text, this method returns null.

If no item with the specified name exists, this method returns null. It does not throw an exception. Use hasItem to verify the existence of an item.

Returns:

The value of the item as a DDateRange or null if the item doesn't contain any date/time value. The second value may be null if only one date/time was specified.

setValueString

void setValueString(java.lang.String value)

Sets the value of an item to a single string value.

Parameters:

value - the value to set

setValueInteger

void setValueInteger(int i)

Sets the value of an item to a single numeric value.

If you want to simulate an empty field in the Lotus Notes Client, you should use this method with an object argument.

Parameters:

i - the value

See Also:

setValueDouble(java.lang.Double)

setValueInteger

void setValueInteger(java.lang.Integer i)

Sets the value of an item to a single numeric value.

If the value is null, a TEXT item with an empty string value is set. This behavior is the same as the Lotus Notes Client does with empty fields.

Parameters:

i - the value

setValueDouble

void setValueDouble(double d)

Sets the value of an item to a single numeric value.

If you want to simulate an empty field in the Lotus Notes Client, you should use this method with an object argument.

Parameters:

d - the value

See Also:

setValueDouble(java.lang.Double)

setValueDouble

void setValueDouble(java.lang.Double d)

Sets the value of an item to a single numeric value.

If the value is null, a TEXT item with an empty string value is set. This behavior is the same as the Lotus Notes Client does with empty fields.

Parameters:

d - the value

setValueDateTime

void setValueDateTime(java.util.Calendar calendar)

Sets the value of an item to a single datetime value. The milliseconds are cut off.

Parameters:

calendar - the date

setValueDateTime

void setValueDateTime(java.util.TimeZone timezone)

Sets the value of an item to a single time zone value.

Parameters:

timezone - the time zone

setValueDateRange

void setValueDateRange(DDateRange dateRange)

Sets the value of an item to a date range.

If the value is null, a TEXT item with an empty string value is set. This behavior is the same as the Lotus Notes Client does with empty fields.

If both calendars are null, an item with an empty string is created. If only one calendar is not null, this calendar is stored as a single date value.

The milliseconds are cut off.

Parameters:

dateRange - the date range

setValueDateRange

void setValueDateRange(java.util.Calendar calendar1,
                       java.util.Calendar calendar2)

Sets the value of an item to a date range.

If both calendars are null, an item with an empty string is created. If only one calendar is not null, this calendar is stored as a single date value.

The milliseconds are cut off.

Parameters:

calendar1 - start date/time of range

calendar2 - end date/time of range

appendToTextList

void appendToTextList(java.lang.String value)

For an item that's a text list, adds a new value to the item without erasing any existing values.

Parameters:

value - The string you want to add to the item.

appendToTextList

void appendToTextList(java.util.List values)

For an item that's a text list, adds a new value to the item without erasing any existing values.

Parameters:

values - The string(s) you want to add to the item. Each list element is an object of type String.

See Also:

appendToTextList(java.lang.String)

containsValue

boolean containsValue(java.lang.String value)

Checks whether a value matches at least one of an item's values.

Parameters:

value - String value to check for

Returns:

true if the value matches one of the values in the item

containsValue

boolean containsValue(java.lang.Integer value)

Checks whether a value matches at least one of an item's values.

Parameters:

value - integer value to check for

Returns:

true if the value matches one of the values in the item

containsValue

boolean containsValue(int value)

Checks whether a value matches at least one of an item's values.

Parameters:

value - integer value to check for

Returns:

true if the value matches one of the values in the item

containsValue

boolean containsValue(java.lang.Double value)

Checks whether a value matches at least one of an item's values.

Parameters:

value - integer value to check for

Returns:

true if the value matches one of the values in the item

containsValue

boolean containsValue(double value)

Checks whether a value matches at least one of an item's values.

Parameters:

value - integer value to check for

Returns:

true if the value matches one of the values in the item

containsValue

boolean containsValue(java.util.Calendar value)

Checks whether a value matches at least one of an item's values.

Parameters:

value - Calendar value to check for

Returns:

true if the value matches one of the values in the item

isSummary

boolean isSummary()

Indicates whether an item contains summary or non-summary data.

Items are flagged as containing summary or non-summary data. Summary data can appear in views and folders; non-summary data cannot. In general, items created through the UI are tagged as non-summary if they contain rich text or are very long.

When you create a new item using appendItemValue or replaceItemValue in NotesDocument, the isSummary property for the item is true. If you don't want the item to appear in views and folders, you must change its IsSummary property to false.

You can enable or disable the appearance of an existing item in views and folders by changing its IsSummary property.

An item whose IsSummary property is true may not appear as expected in views and folders if the data is not suitable. For example, a rich text item whose IsSummary property is true generally appears as a question mark.

Returns:

true if the item contains summary data false if the item contains non-summary data

setSummary

void setSummary(boolean flag)

Indicates whether an item contains summary or non-summary data.

Items are flagged as containing summary or non-summary data. Summary data can appear in views and folders; non-summary data cannot. In general, items created through the UI are tagged as non-summary if they contain rich text or are very long.

When you create a new item using appendItemValue or replaceItemValue in NotesDocument, the isSummary property for the item is true. If you don't want the item to appear in views and folders, you must change its IsSummary property to false.

You can enable or disable the appearance of an existing item in views and folders by changing its IsSummary property.

Example:

 DDocument doc;
 //...set value of doc...
 doc.replaceItemValue("MyNoSummaryItem", "myValue").setSummary(false);
 

Parameters:

flag - true if the item contains summary data false if the item contains non-summary data

isReaders

boolean isReaders()

Indicates whether an item is of type Readers.

Usage
A Readers item contains a list of user names indicating people who have Reader access to a document. A Readers item returns Item.TEXT for getType.

Returns:

true if the item is of type Readers, else false.

isNames

boolean isNames()

Indicates whether an item is of type Names.

Usage
A Names item contains a list of user names. A Names item returns Item.TEXT for getType.

Returns:

true if the item is of type Names, else false.

setNames

void setNames(boolean flag)

Indicates whether an item is of type Names.

Usage
A Names item contains a list of user names. A Readers item returns Item.TEXT for getType.

Example:

 DDocument doc;
 //...set value of doc...
 doc.replaceItemValue("MyNames", "[Admin]").setNames(true);
 

Parameters:

flag - true if the item should be of type Names, elsefalse.

setReaders

void setReaders(boolean flag)

Indicates whether an item is of type Readers.

Usage
A Readers item contains a list of user names indicating people who have Reader access to a document. A Readers item returns Item.TEXT for getType.

Example:

 DDocument doc;
 //...set value of doc...
 doc.replaceItemValue("MyReaders", "[Admin]").setReaders(true);
 

Parameters:

flag - true if the item should be of type Readers, elsefalse.

isAuthors

boolean isAuthors()

Indicates whether an item is of type Authors.

Usage
An Authors item contains a list of user names indicating people who have Author access to a document. An Authors item returns Item.TEXT for getType.

Returns:

true if the item is of type Authors, else false.

isProtected

boolean isProtected()

Indicates whether a user needs at least Editor access to modify an item.

Returns:

true if you need at least Editor access to modify the item, false if you do not need Editor access to modify the item; you can modify it as long as you have Author access or better

setAuthors

void setAuthors(boolean flag)

Indicates whether an item is of type Authors.

Usage
An Authors item contains a list of user names indicating people who have Author access to a document. An Authors item returns Item.TEXT for getType.

Example:

 DDocument doc;
 //...set value of doc...
 doc.replaceItemValue("MyAuthors", "[Admin]").setAuthors(true);
 

Parameters:

flag - true if the item should be of type Authors, elsefalse.

setProtected

void setProtected(boolean flag)

Indicates whether a user needs at least Editor access to modify an item.

Parameters:

flag - true if you need at least Editor access to modify the item, false if you do not need Editor access to modify the item; you can modify it as long as you have Author access or better

getSize

int getSize()

Returns the number of values in a item.

Returns:

number of values in an item.

abstractText

java.lang.String abstractText(int maxlen,
                              boolean dropVowels,
                              boolean userDict)

Abbreviates the contents of a text item.

Parameters:

maxlen - The maximum length of the abbreviation.

dropVowels - Specify true if you want to drop vowels from the words in the item. Otherwise, specify false.

userDict - Specify true if you want to use the table of abbreviations in NOTEABBR.TXT. Otherwise, specify false.

Returns:

The contents of the item, with vowels dropped and abbreviations substituted (if specified), then truncated to fit to maximum length.

copyItemToDocument

DItem copyItemToDocument(DDocument document)

Copies an item to a specified document.

When you call this method using a RichTextItem object, file attachments, embedded objects, and object links that are contained within the rich-text item are not copied to the destination document.

Parameters:

document - The document on which to create the item. Cannot be null.

Returns:

The new item.

copyItemToDocument

DItem copyItemToDocument(DDocument document,
                         java.lang.String newName)

Copies an item to a specified document.

When you call this method using a RichTextItem object, file attachments, embedded objects, and object links that are contained within the rich-text item are not copied to the destination document.

Parameters:

document - The document on which to create the item. Cannot be null.

newName - The name of the new item. Specify an empty string ("") if you want to keep the name of the original item.

Returns:

The new item.

getLastModified

java.util.Calendar getLastModified()

The date that an item was last modified.

Returns:

The date that an item was last modified

getText

java.lang.String getText()

A plain text representation of an item's value.

Multiple values in a list are separated by semicolons in the returned string. If an item's value is large, the returned string may be truncated.

For rich-text items, this property skips non-text data such as bitmaps and file attachments.

For HTML items, this property returns null.

Returns:

plain text representation of an item's value

getText

java.lang.String getText(int maxLen)

A plain text representation of an item's value.

Multiple values in a list are separated by semicolons in the returned string. If an item's value is large, the returned string may be truncated.

For rich-text items, this property skips non-text data such as bitmaps and file attachments.

For HTML items, this property returns null.

Parameters:

maxLen - Maximum length of returned text

Returns:

plain text representation of an item's value

getType

int getType()

The data type of an item.

Returns:

type of an item

getValueLength

int getValueLength()

The bytes of internal storage, including overhead, required to store an item.

Returns:

length of value

setValueCustomData

void setValueCustomData(java.lang.String type,
                        java.lang.Object obj)

Sets the value of an item to custom data from an object.

The new value replaces the existing value.

To keep the changes, you must call Document.save after calling setValueCustomData.

The custom data cannot exceed 64K.

If you intend to get the custom data through a language binding other than Java, use a "Bytes" method.

Parameters:

type - A name for the data type. When getting custom data, use this name for verification.

obj - An object that contains the custom data. The class that defines this object must implement Serializable. If desired, you can override readObject and writeObject.

Since:

Lotus Notes/Domino Release 6

setValueCustomData

void setValueCustomData(java.lang.Object obj)

Sets the value of an item to custom data from an object.

The new value replaces the existing value.

To keep the changes, you must call Document.save after calling setValueCustomData.

The custom data cannot exceed 64K.

If you intend to get the custom data through a language binding other than Java, use a "Bytes" method.

Parameters:

obj - An object that contains the custom data. The class that defines this object must implement Serializable. If desired, you can override readObject and writeObject.

Since:

Lotus Notes/Domino Release 6

setValueCustomDataBytes

void setValueCustomDataBytes(java.lang.String type,
                             byte[] bytes)

Sets the value of an item to custom data from a byte array.

The new value replaces the existing value.

To keep the changes, you must call Document.save after calling setValueCustomData.

The custom data cannot exceed 64K.

If you intend to get the custom data through a language binding other than Java, use a "Bytes" method.

Parameters:

type - A name for the data type. When getting custom data, use this name for verification.

bytes - A byte array that contains the custom data.

Since:

Lotus Notes/Domino Release 6

getValueCustomData

java.lang.Object getValueCustomData(java.lang.String type)

Returns as an object the value of an item containing custom data.

Parameters:

type - The name of the data type. If specified, this name must match the data type name specified when the item was written. If omitted, no name checking occurs.

Returns:

An object that receives the value of the item. Must have the same class definition as the object written to the item.

See Also:

setValueCustomData(String, Object)

getValueCustomData

java.lang.Object getValueCustomData()

Returns as an object the value of an item containing custom data.

Returns:

An object that receives the value of the item. Must have the same class definition as the object written to the item.

See Also:

setValueCustomData(String, Object)

getValueCustomDataBytes

byte[] getValueCustomDataBytes(java.lang.String type)

Returns as a byte array the value of an item containing custom data.

Parameters:

type - The name of the data type. This name must match the data type name specified when the item was written.

Returns:

A byte array that receives the value of the item.

See Also:

setValueCustomDataBytes(String, byte[])

isEncrypted

boolean isEncrypted()

Indicates whether an item is encrypted.

If you set this property to true, the item is not actually encrypted until you call DBaseDocument.encrypt() on the parent Document.

Returns:

true if the item is encrypted, else false

setEncrypted

void setEncrypted(boolean flag)

Indicates whether an item is encrypted.

Parameters:

flag - true if the item is encrypted, else false

isSaveToDisk

boolean isSaveToDisk()

Indicates whether an item is saved when the document is saved.

Returns:

flag true (default) if the item is saved when the document is saved, else false

setSaveToDisk

void setSaveToDisk(boolean flag)

Indicates whether an item is saved when the document is saved.

Parameters:

flag - true (default) if the item is saved when the document is saved, else false

isSigned

boolean isSigned()

Indicates whether a document contains a signature.

use DBaseDocument.getSigner() and DBaseDocument.getVerifier() to get the Signer and Verifier for a signed document. To access the signature itself, you must find the item of type SIGNATURE in the document.

Returns:

true if the document contains one or more signatures, else false

setSigned

void setSigned(boolean flag)

Indicates whether an item contains a signature the next time the document is signed.

Parameters:

flag - true if the item is signed when the document is next signed

getReader

java.io.Reader getReader()

Contents of an EmbeddedObject, Item, or MIMEEntity object in the form of a java.io.Reader object.

Returns:

Contents of an EmbeddedObject, Item, or MIMEEntity object in the form of a java.io.Reader object

This method creates a temporary file. The file is deleted when EmbeddedObject is recycled.

getInputStream

java.io.InputStream getInputStream()

InputStream representation of the contents of an EmbeddedObject, Item, or MIMEEntity object.

This method creates a temporary file. The file is deleted when EmbeddedObject is recycled.

Returns:

InputStream representation of the contents of an EmbeddedObject, Item, or MIMEEntity object