com.compoze.domino
Class AddressBook

java.lang.Object

  |

  +--com.compoze.domino.AbstractItem

        |

        +--com.compoze.domino.AddressBook

All Implemented Interfaces:

java.io.Serializable

public class AddressBook

extends AbstractItem

implements java.io.Serializable

This class is a Domino address book. Address book instances are obtained from the AddressBooks class.

See Also:

Serialized Form

Fields inherited from class com.compoze.domino.AbstractItem

m_props, m_session

Method Summary

java.lang.String	getTitle() Gets the address book title.
AddressBookEntry[]	serverGetAddressBookEntries(int iStartIndex, int iEndIndex, PropertyKey[] keys, java.lang.String sFilterKey) Queries the server to get address book entries from the server between the specified iStartIndex and iEndIndex starting at 0.
int	serverGetAddressBookEntriesCount(java.lang.String sFilterKey) Queries the server to get address book entry count.
void	serverUpdate() Address books cannot be updated.

Methods inherited from class com.compoze.domino.AbstractItem

get, getBoolean, getDate, getDateArray, getDouble, getInt, getPropertyKeys, getString, getStringArray, getUpdatedPropertyValues, set, setBoolean, setDate, setDouble, setInt, setString, setStringArray

Methods inherited from class java.lang.Object

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

Method Detail

getTitle

public java.lang.String getTitle()
                          throws DominoException

Gets the address book title.

Returns:

the address book title

serverGetAddressBookEntries

public AddressBookEntry[] serverGetAddressBookEntries(int iStartIndex,
                                                      int iEndIndex,
                                                      PropertyKey[] keys,
                                                      java.lang.String sFilterKey)
                                               throws DominoException

Queries the server to get address book entries from the server between the specified iStartIndex and iEndIndex starting at 0. The filter key searches the person's last name and is not case sensitive.

Parameters:

iStartIndex - the start index endpoint (inclusive) or -1 for all

iEndIndex - the end index highpoint (exclusive) or -1 for all

keys - the properties to bring back from the address book entries

sFilterKey - the search filter key or null for no search filtering

Returns:

an array of address book entries

See Also:

AddressBookEntry

serverGetAddressBookEntriesCount

public int serverGetAddressBookEntriesCount(java.lang.String sFilterKey)
                                     throws DominoException

Queries the server to get address book entry count. The filter key searches the person's last name and is not case sensitive.

Parameters:

sFilterKey - the search filter key or null for no search filtering

Returns:

the address book entry count or -1 if not available

serverUpdate

public void serverUpdate()
                  throws DominoException

Address books cannot be updated. This method does nothing.

Overrides:

serverUpdate in class AbstractItem