de.uplanet.lucy.server.businesslogic.exchange.util
Interface IExchangeItem

All Known Subinterfaces:

IExchangeAppointment, IExchangeContact, IExchangeMessage, IExchangeNote, IExchangeTask

@Scriptable
public interface IExchangeItem

Defines common properties and methods of an Exchange mailbox item.

Version:

$Revision: 92899 $

Method Summary

void	addAttachment(java.io.File p_file) Adds an attachment to the item.
void	addAttachment(java.io.File p_file, java.lang.String p_strFileName, java.lang.String p_strMimeType, boolean p_bDeleteAfter) Adds an attachment to the item.
void	addCategory(java.lang.String p_strCategory) Adds a category.
void	delete() Deletes the item from the mailbox (i.e. moves it to deleted items folder).
java.util.List<IAttachmentInfo>	getAttachments()
java.util.List<java.lang.String>	getCategories() Returns a list of category values.
java.lang.String	getFolderHref()
java.lang.String	getHref()
java.lang.String	getId()
java.lang.String	getItemLink()
java.lang.String	getPermanentUrl()
java.lang.String	getSubject()
IValueHolder<?>	getUserDefinedFieldValue(java.lang.String p_strColumnName) Returns a user defined field value for the current item.
void	removeAttachment(java.lang.String p_strAttachmentId) Removed an attachment from an item.
void	removeCategory(java.lang.String p_strCategory) Removes a category from the list of categories.
void	save() Saves modified item properties in Exchange.
void	setSubject(java.lang.String p_strSubject) Sets the subject.
void	setUserDefinedFieldValue(java.lang.String p_strColumnName, IValueHolder<?> p_vh) Sets a user defined field value.

Method Detail

getId

java.lang.String getId()

Returns:

The item ID.

getHref

java.lang.String getHref()

Returns:

The item HREF.

getFolderHref

java.lang.String getFolderHref()

Returns:

The item's folder HREF.

getSubject

java.lang.String getSubject()

Returns:

The subject.

setSubject

void setSubject(java.lang.String p_strSubject)

Sets the subject.

Parameters:

p_strSubject - The subject.

getPermanentUrl

java.lang.String getPermanentUrl()

Returns:

The item's permanent URL.

getItemLink

java.lang.String getItemLink()

Returns:

An URL to open the item in OWA.

getAttachments

java.util.List<IAttachmentInfo> getAttachments()

Returns:

A list of attachments.

addAttachment

void addAttachment(java.io.File p_file)
                   throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException

Adds an attachment to the item.

Parameters:

p_file - The file to add as attachment.

Throws:

ExchangeUtilException - If operation fails.

addAttachment

void addAttachment(java.io.File p_file,
                   java.lang.String p_strFileName,
                   java.lang.String p_strMimeType,
                   boolean p_bDeleteAfter)
                   throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException

Adds an attachment to the item.

Parameters:

p_file - The file to add as attachment.

p_strFileName - The name used as attachment file name.

p_strMimeType - The MIME type.

p_bDeleteAfter - True if the file should be deleted after it has been attached.

Throws:

ExchangeUtilException - If operation fails.

removeAttachment

void removeAttachment(java.lang.String p_strAttachmentId)
                      throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException

Removed an attachment from an item.

Parameters:

p_strAttachmentId - The attachment ID.

Throws:

ExchangeUtilException - If operation fails.

save

void save()
          throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException

Saves modified item properties in Exchange. In order to get the latest values of fields updated automatically by Exchange, it might be necessary to reload the item after it has been saved.

Throws:

ExchangeUtilException - If item could not be saved.

delete

void delete()
            throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException

Deletes the item from the mailbox (i.e. moves it to deleted items folder).

Throws:

ExchangeUtilException - If item could not be deleted.

getUserDefinedFieldValue

IValueHolder<?> getUserDefinedFieldValue(java.lang.String p_strColumnName)
                                         throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException

Returns a user defined field value for the current item. This allows to get values of custom fields or fields not provided as properties in the concrete item class.

Parameters:

p_strColumnName - The column name of the user defined field (e.g. 'IntrexxGuid').

Returns:

The user defined field value for the current item.

Throws:

de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException

setUserDefinedFieldValue

void setUserDefinedFieldValue(java.lang.String p_strColumnName,
                              IValueHolder<?> p_vh)
                              throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException

Sets a user defined field value. This allows to get values of custom fields or fields not provided as properties in the concrete item class.

Parameters:

p_strColumnName - The column name of the user defined field (e.g. 'IntrexxGuid').

p_vh - The value holder for the user defined field value (must also define the IxDataType of the field).

Throws:

de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException

getCategories

java.util.List<java.lang.String> getCategories()
                                               throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException

Returns a list of category values.

Returns:

A list of category values.

Throws:

ExchangeUtilException

addCategory

void addCategory(java.lang.String p_strCategory)
                 throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException

Adds a category.

Parameters:

p_strCategory - The category value.

Throws:

ExchangeUtilException

removeCategory

void removeCategory(java.lang.String p_strCategory)
                    throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException

Removes a category from the list of categories.

Parameters:

p_strCategory - The category to remove.

Throws:

ExchangeUtilException