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

Interface IExchangeItem

    • Method Detail

      • getId

        String getId()
        Returns:
        The item ID.

      • getHref

        String getHref()
        Returns:
        The item HREF.

      • getFolderHref

        String getFolderHref()
        Returns:
        The item's folder HREF.

      • getSubject

        String getSubject()
        Returns:
        The subject.

      • setSubject

        void setSubject​(String p_strSubject)
        Sets the subject.
        Parameters:
        p_strSubject - The subject.

      • getPermanentUrl

        String getPermanentUrl()
        Returns:
        The item's permanent URL.

      • getItemLink

        String getItemLink()
        Returns:
        An URL to open the item in OWA.

      • addAttachment

        void addAttachment​(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:
        de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If operation fails.

      • addAttachment

        void addAttachment​(File p_file,
                   String p_strFileName,
                   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:
        de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If operation fails.

      • removeAttachment

        void removeAttachment​(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:
        de.uplanet.lucy.server.businesslogic.exchange.util.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:
        de.uplanet.lucy.server.businesslogic.exchange.util.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:
        de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If item could not be deleted.

      • getUserDefinedFieldValue

        IValueHolder<?> getUserDefinedFieldValue​(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​(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

        List<String> getCategories()
                    throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
        Returns a list of category values.
        Returns:
        A list of category values.
        Throws:
        de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException

      • addCategory

        void addCategory​(String p_strCategory)
          throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
        Adds a category.
        Parameters:
        p_strCategory - The category value.
        Throws:
        de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException

      • removeCategory

        void removeCategory​(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:
        de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException