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

Interface IExchangeContactUtil

  • All Known Implementing Classes:
    ExchangeContactUtil
    @Scriptable
public interface IExchangeContactUtil
    Defines utility methods for working with MS Exchange contacts.

    • Method Detail

      • createNew

        @Deprecated
IExchangeContact createNew​(String p_strSurname,
                           String p_strGivenName,
                           String p_strEmailAddress,
                           String p_strUserMailbox)
                    throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
        Deprecated.
        Creates a new contact.
        Parameters:
        p_strSurname - The surname.
        p_strGivenName - The given name.
        p_strEmailAddress - The email address.
        p_strUserMailbox - The mailbox the contact belongs to.
        Returns:
        The new IExchangeContact instance.
        Throws:
        de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If the contact could not be created.

      • createNew

        @Deprecated
IExchangeContact createNew​(String p_strSurname,
                           String p_strGivenName,
                           String p_strEmailAddress,
                           String p_strPersonalTitle,
                           String p_strStreet,
                           String p_strPostalCode,
                           String p_strCity,
                           String p_strCountry,
                           String p_strTelephoneNumber,
                           String p_strMobile,
                           String p_strOrganization,
                           String p_strUserMailbox)
                    throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
        Deprecated.
        Creates a new contact.
        Parameters:
        p_strSurname - The surname.
        p_strGivenName - The given name.
        p_strEmailAddress - The email address.
        p_strPersonalTitle - The personal title (Mr./Mrs.)
        p_strStreet - The street.
        p_strPostalCode - The postal code.
        p_strCity - The city.
        p_strCountry - The country.
        p_strTelephoneNumber - The telephone number.
        p_strMobile - The mobile number.
        p_strOrganization - The organization.
        p_strUserMailbox - The mailbox the contact belongs to.
        Returns:
        The new IExchangeContact instance.
        Throws:
        de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If the contact could not be created.

      • createNew

        @Deprecated
IExchangeContact createNew​(String p_strSurname,
                           String p_strGivenName,
                           String p_strEmail1Address,
                           String p_strEmail1OriginalDisplayName,
                           String p_strEmail2Address,
                           String p_strEmail2OriginalDisplayName,
                           String p_strEmail3Address,
                           String p_strEmail3OriginalDisplayName,
                           String p_strUserMailbox)
                    throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
        Deprecated.
        Creates a new contact.
        Parameters:
        p_strSurname - The surname.
        p_strGivenName - The given name.
        p_strEmail1Address - The email 1 address.
        p_strEmail1OriginalDisplayName - The email 1 original display name.
        p_strEmail2Address - The email 2 address.
        p_strEmail2OriginalDisplayName - The email 2 original display name.
        p_strEmail3Address - The email 3 address.
        p_strEmail3OriginalDisplayName - The email 3 original display name.
        p_strUserMailbox - The mailbox the contact belongs to.
        Returns:
        The new IExchangeContact instance.
        Throws:
        de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If the contact could not be created.

      • createNewContact

        IExchangeContact createNewContact​(String p_strSurname,
                                  String p_strGivenName,
                                  String p_strEmailAddress,
                                  String p_strUserMailbox)
                           throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
        Creates a new contact.
        Parameters:
        p_strSurname - The surname.
        p_strGivenName - The given name.
        p_strEmailAddress - The email address.
        p_strUserMailbox - The mailbox the contact belongs to.
        Returns:
        The new IExchangeContact instance.
        Throws:
        de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If the contact could not be created.

      • createNewContact

        IExchangeContact createNewContact​(String p_strSurname,
                                  String p_strGivenName,
                                  String p_strEmailAddress,
                                  String p_strPersonalTitle,
                                  String p_strStreet,
                                  String p_strPostalCode,
                                  String p_strCity,
                                  String p_strCountry,
                                  String p_strTelephoneNumber,
                                  String p_strMobile,
                                  String p_strOrganization,
                                  String p_strUserMailbox)
                           throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
        Creates a new contact.
        Parameters:
        p_strSurname - The surname.
        p_strGivenName - The given name.
        p_strEmailAddress - The email address.
        p_strPersonalTitle - The personal title (Mr./Mrs.)
        p_strStreet - The street.
        p_strPostalCode - The postal code.
        p_strCity - The city.
        p_strCountry - The country.
        p_strTelephoneNumber - The telephone number.
        p_strMobile - The mobile number.
        p_strOrganization - The organization.
        p_strUserMailbox - The mailbox the contact belongs to.
        Returns:
        The new IExchangeContact instance.
        Throws:
        de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If the contact could not be created.

      • createNewContact

        IExchangeContact createNewContact​(String p_strSurname,
                                  String p_strGivenName,
                                  String p_strEmail1Address,
                                  String p_strEmail1OriginalDisplayName,
                                  String p_strEmail2Address,
                                  String p_strEmail2OriginalDisplayName,
                                  String p_strEmail3Address,
                                  String p_strEmail3OriginalDisplayName,
                                  String p_strUserMailbox)
                           throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
        Creates a new contact.
        Parameters:
        p_strSurname - The surname.
        p_strGivenName - The given name.
        p_strEmail1Address - The email 1 address.
        p_strEmail1OriginalDisplayName - The email 1 original display name.
        p_strEmail2Address - The email 2 address.
        p_strEmail2OriginalDisplayName - The email 2 original display name.
        p_strEmail3Address - The email 3 address.
        p_strEmail3OriginalDisplayName - The email 3 original display name.
        p_strUserMailbox - The mailbox the contact belongs to.
        Returns:
        The new IExchangeContact instance.
        Throws:
        de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If the contact could not be created.

      • findById

        IExchangeContact findById​(String p_strId)
                   throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
        Finds a contact by the given ID.
        Parameters:
        p_strId - The contact ID.
        Returns:
        The IExchangeContact instance.
        Throws:
        de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If the contact could not be found.

      • findByPermanentUrl

        IExchangeContact findByPermanentUrl​(String p_strPermUrl)
                             throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
        Finds a task by the given Permanent URL.
        Parameters:
        p_strPermUrl - The permanent URL.
        Returns:
        The IExchangeContact.
        Throws:
        de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If the contact could not be found.

      • createFolder

        String createFolder​(String p_strParentHref,
                    String p_strFolderName)
             throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
        Creates a new folder. The display name can be an arbitrary string. The HREF and parent HREF parameters must include the canonical path to the folder. Consider the following structure:

        + Folder1
        ++ Folder2
        +++ MyNewFolder

        To create 'MyNewFolder' beneath 'Folder2' the following values are required:

        Folder name: MyNewFolder
        Parent HREF: /Folder1/Folder2/
        Parameters:
        p_strParentHref - The HREF of the parent folder (required).
        p_strFolderName - The folder name.
        Returns:
        The ID of the new folder.
        Throws:
        de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If operation failed.