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

Interface IExchangeAppointmentUtil

  • All Known Implementing Classes:
    ExchangeAppointmentUtil
    @Scriptable
public interface IExchangeAppointmentUtil
    Defines utility methods for MS Exchange appointments.

    • Method Detail

      • createNewAppointment

        IExchangeAppointment createNewAppointment​(Date p_dateStart,
                                          Date p_dateEnd,
                                          String p_strSubject,
                                          String p_strBody)
                                   throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
        Creates a new appointment in the current user's mailbox.
        Parameters:
        p_dateStart - The start date.
        p_dateEnd - The end date.
        p_strSubject - The appointment subject.
        p_strBody - The appointment body.
        Returns:
        The IExchangeAppointment instance.
        Throws:
        de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If appointment could not be created.

      • createNewAppointment

        IExchangeAppointment createNewAppointment​(Date p_dateStart,
                                          Date p_dateEnd,
                                          String p_strSubject,
                                          String p_strBody,
                                          String p_strFKUserMailbox)
                                   throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
        Creates a new appointment in another user's mailbox.
        Parameters:
        p_dateStart - The start date.
        p_dateEnd - The end date.
        p_strSubject - The appointment subject.
        p_strBody - The appointment body.
        p_strFKUserMailbox - The name of the user's mailbox.
        Returns:
        The IExchangeAppointment instance.
        Throws:
        de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If appointment could not be created.

      • createNewMeeting

        IExchangeAppointment createNewMeeting​(Date p_dateStart,
                                      Date p_dateEnd,
                                      String p_strSubject,
                                      String p_strBody,
                                      String p_strLocation,
                                      String p_strAttendees,
                                      boolean p_bResponseRequested)
                               throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
        Creates a new meeting with attendees.
        Parameters:
        p_dateStart - The start date.
        p_dateEnd - The end date.
        p_strSubject - The appointment subject.
        p_strBody - The appointment body.
        p_strLocation - The meeting location.
        p_strAttendees - A comma-separated list of attendees (email address).
        p_bResponseRequested - true if a response is requested from the attendees.
        Returns:
        The IExchangeAppointment instance.
        Throws:
        de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If appointment could not be created.

      • createNewMeeting

        IExchangeAppointment createNewMeeting​(Date p_dateStart,
                                      Date p_dateEnd,
                                      String p_strSubject,
                                      String p_strBody,
                                      String p_strLocation,
                                      String p_strAttendees,
                                      boolean p_bResponseRequested,
                                      String p_strFKUserMailbox)
                               throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
        Creates a new meeting with attendees in another user's mailbox.
        Parameters:
        p_dateStart - The start date.
        p_dateEnd - The end date.
        p_strSubject - The appointment subject.
        p_strBody - The appointment body.
        p_strLocation - The meeting location.
        p_strAttendees - A comma-separated list of attendees (email address).
        p_bResponseRequested - true if a response is requested from the attendees.
        p_strFKUserMailbox - The name of the user's mailbox.
        Returns:
        The IExchangeAppointment instance.
        Throws:
        de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If appointment could not be created.

      • findById

        IExchangeAppointment findById​(String p_strId)
                       throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
        Loads an appointment with the given ID.
        Parameters:
        p_strId - The appointment ID.
        Returns:
        The IExchangeAppointment instance.
        Throws:
        de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If appointment could not be found.

      • findByPermanentUrl

        IExchangeAppointment findByPermanentUrl​(String p_strPermUrl)
                                 throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
        Loads a appointment with the given permanent URL.
        Parameters:
        p_strPermUrl - The permanent URL.
        Returns:
        The IExchangeAppointment instance.
        Throws:
        de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If appointment could not be found.

      • sendMeetingRequest

        void sendMeetingRequest​(String p_strAppointmentId)
                 throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
        Sends meeting request mails to all participants of an appointment.
        Parameters:
        p_strAppointmentId - The ID of the appointment.
        Throws:
        de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If operation failed.

      • cancelMeeting

        void cancelMeeting​(String p_strAppointmentId)
            throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
        Cancels a meeting.
        Parameters:
        p_strAppointmentId - The ID of the appointment.
        Throws:
        de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If operation failed.

      • 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.

      • selectFreeBusyTime

        List<de.uplanet.lucy.server.businesslogic.exchange.util.FreeBusyItem> selectFreeBusyTime​(String p_strEmailAddress,
                                                                                         Date p_dateStart,
                                                                                         Date p_dateEnd,
                                                                                         int p_iTimeZoneId)
                                                                                  throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException
        Selects free/busy times.
        Parameters:
        p_strEmailAddress - The person's email address.
        p_dateStart - The interval start date.
        p_dateEnd - The interval end date.
        p_iTimeZoneId - The time zone ID from table TimeZone.
        Returns:
        List of appointment items.
        Throws:
        de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException