com.ibm.notes.java.ui.documents
Interface NotesBEDocument

public interface NotesBEDocument

An Object that provides access to change and add information to a Notes back-end document.

Restriction:

This interface is not intended to be implemented by clients.

Method Summary

Calendar	getItemCalendar(String name) Return the value as a Calendar for the given item.
double	getItemDouble(String name) Return the value as a Double for the given item.
int	getItemInteger(String name) Return the value as an Integer for the given item.
List	getItemList(String name) Return the values as a List for the given item.
String	getItemString(String name) Return the values as a String for the given item.
boolean	hasItem(String name) Returns true if the item exists on the document.
void	removeItem(String name) Remove the item with the given name from the document.
void	setItemValue(String name, Object value) Replaces all items of the specified name with one new item, which is assigned the specified value.

Method Detail

removeItem

void removeItem(String name)

Remove the item with the given name from the document.

Parameters:

name - name of item to remove

Since:

8.5.1

setItemValue

void setItemValue(String name,
                  Object value)

Replaces all items of the specified name with one new item, which is assigned the specified value. If the document does not contain an item with the specified name, this method creates a new item and adds it to the document.

Note that there is a limit to the number of characters you can use to set the value on an item. If the length of the value passed into this method exceeds 30,000 characters, you may see unexpected results.

Parameters:

name - the item name

value - value to set, the following value types will be created from the noted Objects:
Text: String
Number: Integer, Double
DateTime: Calendar, Date
List: Collection of single type of above items

Since:

8.5.1

getItemList

List getItemList(String name)

Return the values as a List for the given item. This allows the caller to retrieve every value from each item.

Parameters:

name - name of item

Returns:

the list of all values

Since:

8.5.1

hasItem

boolean hasItem(String name)

Returns true if the item exists on the document.

Parameters:

name - name of the item

Returns:

true if the item is on the document, false if the item is not on the document

Since:

8.5.1

getItemString

String getItemString(String name)

Return the values as a String for the given item. Multiple values are condensed into a single String.

Parameters:

name - name of the item

Returns:

the value of the item as a String

Since:

8.5.1

getItemDouble

double getItemDouble(String name)

Return the value as a Double for the given item. The first value in the item is returned.

Parameters:

name - name of the item

Returns:

the value of the item as a double

Since:

8.5.1

getItemInteger

int getItemInteger(String name)

Return the value as an Integer for the given item. The first value in the item is returned.

Parameters:

name - name of the item

Returns:

the value of the item as an integer

Since:

8.5.1

getItemCalendar

Calendar getItemCalendar(String name)

Return the value as a Calendar for the given item. Calendars allow access to all of the date information. The first value in the item is returned.

Parameters:

name - name of the item

Returns:

the value of the item as a Calendar

Since:

8.5.1