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

Class ExchangeAppointmentUtil

java.lang.Object

de.uplanet.lucy.server.businesslogic.exchange.util.impl.ExchangeAppointmentUtil

All Implemented Interfaces:

IExchangeAppointmentUtil

@Scriptable
public class ExchangeAppointmentUtil
extends Object
implements IExchangeAppointmentUtil

Utility class for MS Exchange appointments.

Method Summary

Modifier and Type	Method	Description
void	cancelMeeting(String p_strAppointmentId)	Cancels a meeting.
String	createFolder(String p_strParentHref, String p_strFolderName)	Creates a new folder.
IExchangeAppointment	createNewAppointment(Date p_dateStart, Date p_dateEnd, String p_strSubject, String p_strBody)	Creates a new appointment in the current user's mailbox.
IExchangeAppointment	createNewAppointment(Date p_dateStart, Date p_dateEnd, String p_strSubject, String p_strBody, String p_strFKUserMailbox)	Creates a new appointment in another user's mailbox.
IExchangeAppointment	createNewMeeting(Date p_dateStart, Date p_dateEnd, String p_strSubject, String p_strBody, String p_strLocation, String p_strAttendees, boolean p_bResponseRequested)	Creates a new meeting with attendees.
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)	Creates a new meeting with attendees in another user's mailbox.
IExchangeAppointment	findById(String p_strId)	Loads an appointment with the given ID.
IExchangeAppointment	findByPermanentUrl(String p_strPermUrl)	Loads a appointment with the given permanent URL.
static IExchangeAppointmentUtil	getInstance()	Returns an instance initialized with a Exchange connection for the currently logged in user.
static IExchangeAppointmentUtil	getInstance(Connection p_conn)	Returns an instance initialized with the given Exchange connection.
List<de.uplanet.lucy.server.businesslogic.exchange.util.FreeBusyItem>	selectFreeBusyTime(String p_strEmailAddress, Date p_dateStart, Date p_dateEnd, int p_iTimeZoneId)	Selects free/busy times.
void	sendMeetingRequest(String p_strAppointmentId)	Sends meeting request mails to all participants of an appointment.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInstance

public static IExchangeAppointmentUtil getInstance()

Returns an instance initialized with a Exchange connection for the currently logged in user.

Returns:

The instance.

getInstance

public static IExchangeAppointmentUtil getInstance(Connection p_conn)

Returns an instance initialized with the given Exchange connection.

Parameters:

p_conn - The MS Exchange connection.

Returns:

The instance.

createNewAppointment

public IExchangeAppointment createNewAppointment(Date p_dateStart,
                                                 Date p_dateEnd,
                                                 String p_strSubject,
                                                 String p_strBody)
                                          throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException

Description copied from interface: IExchangeAppointmentUtil

Creates a new appointment in the current user's mailbox.

Specified by:

createNewAppointment in interface IExchangeAppointmentUtil

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

public 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

Description copied from interface: IExchangeAppointmentUtil

Creates a new appointment in another user's mailbox.

Specified by:

createNewAppointment in interface IExchangeAppointmentUtil

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

public 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

Description copied from interface: IExchangeAppointmentUtil

Creates a new meeting with attendees.

Specified by:

createNewMeeting in interface IExchangeAppointmentUtil

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

public 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

Description copied from interface: IExchangeAppointmentUtil

Creates a new meeting with attendees in another user's mailbox.

Specified by:

createNewMeeting in interface IExchangeAppointmentUtil

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

public IExchangeAppointment findById(String p_strId)
                              throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException

Description copied from interface: IExchangeAppointmentUtil

Loads an appointment with the given ID.

Specified by:

findById in interface IExchangeAppointmentUtil

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

public IExchangeAppointment findByPermanentUrl(String p_strPermUrl)
                                        throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException

Description copied from interface: IExchangeAppointmentUtil

Loads a appointment with the given permanent URL.

Specified by:

findByPermanentUrl in interface IExchangeAppointmentUtil

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

public void sendMeetingRequest(String p_strAppointmentId)
                        throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException

Description copied from interface: IExchangeAppointmentUtil

Sends meeting request mails to all participants of an appointment.

Specified by:

sendMeetingRequest in interface IExchangeAppointmentUtil

Parameters:

p_strAppointmentId - The ID of the appointment.

Throws:

de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If operation failed.

cancelMeeting

public void cancelMeeting(String p_strAppointmentId)
                   throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException

Description copied from interface: IExchangeAppointmentUtil

Cancels a meeting.

Specified by:

cancelMeeting in interface IExchangeAppointmentUtil

Parameters:

p_strAppointmentId - The ID of the appointment.

Throws:

de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException - If operation failed.

selectFreeBusyTime

public 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

Description copied from interface: IExchangeAppointmentUtil

Selects free/busy times.

Specified by:

selectFreeBusyTime in interface IExchangeAppointmentUtil

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

createFolder

public String createFolder(String p_strParentHref,
                           String p_strFolderName)
                    throws de.uplanet.lucy.server.businesslogic.exchange.util.ExchangeUtilException

Description copied from interface: IExchangeAppointmentUtil

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/

Specified by:

createFolder in interface IExchangeAppointmentUtil

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.