com.compoze.domino
Class AddressBookEntry

java.lang.Object

  |

  +--com.compoze.domino.AbstractItem

        |

        +--com.compoze.domino.AbstractDocument

              |

              +--com.compoze.domino.AddressEntry

                    |

                    +--com.compoze.domino.AddressBookEntry

All Implemented Interfaces:

java.io.Serializable

public class AddressBookEntry

extends AddressEntry

implements java.io.Serializable

This class is a Domino address book entry. Address book entry instances are obtained from the AddressBook class. Methods that access properites on the class require that the properties were loaded beforehand, when the address book entry was initially retrieved. Any methods in this class that begin with the string server make a query to the server.

See Also:

Serialized Form

Field Summary

static PropertyKey[]

ALL_PROPS Contains an array of all of the properties available on a address book entry.

Fields inherited from class com.compoze.domino.AbstractItem

m_props, m_session

Method Summary

java.lang.String	getAddress() Gets the address of the address book entry.
AttachmentInfo	getAttachmentInfo(int iIndex) You cannot retrieve attachment info from address book entries.
AttachmentInfo[]	getAttachmentInfoArray() You cannot retrieve attachment info from address book entries.
java.lang.String	getDisplayName() Gets the display name of the address book entry.
java.lang.String	getEmailAddress() Gets the email address of the address book entry.
java.lang.String	getFirstName() Gets the first name of the address book entry.
java.lang.String	getFullName() Gets the full name of the address book entry.
java.lang.String	getLastName() Gets the last name of the address book entry.
java.lang.String	getMiddleInitial() Gets the middle initial of the address book entry.
java.lang.String	getSuffix() Gets the suffix of the address book entry, for example 'Jr', 'Sr', 'III'.
java.lang.String	getTitle() Gets the title of the address book entry.
void	serverAddAttachment(java.lang.String sName, javax.activation.DataHandler handler) You cannot add attachments to address book entries.
void	serverDeleteAttachment(int iIndex) You cannot delete attachments from address book entries.
void	serverUpdate() Address book entries cannot be updated.

Methods inherited from class com.compoze.domino.AbstractDocument

getAttachmentCount, getDateCreated, getDateCreatedString, getDateModified, getDateModifiedString, getDocumentType, getEmbeddedImageCount, getEmbeddedImageInfo, getEmbeddedImageInfoArray, getID, getParentID, getSize, getSizeInKilos, hasAttachment, serverCopyTo, serverMoveTo

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

Field Detail

ALL_PROPS

public static final PropertyKey[] ALL_PROPS

Contains an array of all of the properties available on a address book entry. Although this can be used when specifying property keys to retrieve, it's preferable to only specify the keys that are required as the number of properties that are pulled back from the server has a direct impact on performance.

Method Detail

getMiddleInitial

public java.lang.String getMiddleInitial()
                                  throws DominoException

Gets the middle initial of the address book entry.

Returns:

the middle initial of the address book entry

See Also:

PropertyKey.MIDDLE_INITIAL

getSuffix

public java.lang.String getSuffix()
                           throws DominoException

Gets the suffix of the address book entry, for example 'Jr', 'Sr', 'III'.

Returns:

the suffix of the address book entry

See Also:

PropertyKey.SUFFIX, Suffix

getTitle

public java.lang.String getTitle()
                          throws DominoException

Gets the title of the address book entry.

Returns:

the title of the address book entry

See Also:

PropertyKey.TITLE, Title

getDisplayName

public java.lang.String getDisplayName()
                                throws DominoException

Gets the display name of the address book entry. This will return the full name (if available) or a combination of the first, middle and last name, depending on what is set and available.

Overrides:

getDisplayName in class AddressEntry

Returns:

the display name of the address book entry

See Also:

PropertyKey.FIRST_NAME, PropertyKey.LAST_NAME, PropertyKey.MIDDLE_INITIAL, PropertyKey.FULL_NAME, PropertyKey.TITLE, PropertyKey.SUFFIX

getFullName

public java.lang.String getFullName()
                             throws DominoException

Gets the full name of the address book entry.

Returns:

the full name of the address book entry

See Also:

PropertyKey.FULL_NAME

getLastName

public java.lang.String getLastName()
                             throws DominoException

Gets the last name of the address book entry.

Returns:

the last name of the address book entry

See Also:

PropertyKey.LAST_NAME

getFirstName

public java.lang.String getFirstName()
                              throws DominoException

Gets the first name of the address book entry.

Returns:

the first name of the address book entry

See Also:

PropertyKey.FIRST_NAME

getAddress

public java.lang.String getAddress()
                            throws DominoException

Gets the address of the address book entry.

Overrides:

getAddress in class AddressEntry

Returns:

the address of the address book entry

See Also:

PropertyKey.FULL_NAME

getEmailAddress

public java.lang.String getEmailAddress()
                                 throws DominoException

Gets the email address of the address book entry.

Returns:

the email address of the address book entry

See Also:

PropertyKey.INTERNET_ADDRESS

getAttachmentInfo

public AttachmentInfo getAttachmentInfo(int iIndex)
                                 throws DominoException

You cannot retrieve attachment info from address book entries. This methods throws UnsupportedOperationException.

Overrides:

getAttachmentInfo in class AbstractDocument

Following copied from class: com.compoze.domino.AbstractDocument

Parameters:

iIndex - the attachment index

Returns:

the attachment info or null if attachment index does not exist

See Also:

PropertyKey.ATTACHMENT_INFO

getAttachmentInfoArray

public AttachmentInfo[] getAttachmentInfoArray()
                                        throws DominoException

You cannot retrieve attachment info from address book entries. This methods throws UnsupportedOperationException.

Overrides:

getAttachmentInfoArray in class AbstractDocument

Following copied from class: com.compoze.domino.AbstractDocument

Returns:

an array of attachment info or an empty array if the document has no attachments

See Also:

PropertyKey.ATTACHMENT_INFO

serverAddAttachment

public void serverAddAttachment(java.lang.String sName,
                                javax.activation.DataHandler handler)
                         throws DominoException

You cannot add attachments to address book entries. This methods throws UnsupportedOperationException.

Overrides:

serverAddAttachment in class AbstractDocument

Following copied from class: com.compoze.domino.AbstractDocument

Parameters:

sName - the name of the attachment

handler - a handler that can supply the attachment data

Throws:

DominoException - an error occurs while connecting to the Compoze Domino Service. An AttachmentSizeLimitException is thrown if the attachment exceeds the attachment setting limit in the Compoze Domino Service. Use instanceof to determine if this exception is thrown.

serverDeleteAttachment

public void serverDeleteAttachment(int iIndex)
                            throws DominoException

You cannot delete attachments from address book entries. This methods throws UnsupportedOperationException.

Overrides:

serverDeleteAttachment in class AbstractDocument

Following copied from class: com.compoze.domino.AbstractDocument

Parameters:

iIndex - the index of the attachment to delete

serverUpdate

public void serverUpdate()
                  throws DominoException

Address book entries cannot be updated. This method does nothing.

Overrides:

serverUpdate in class AbstractDocument