jec
Interface EWSConnectorInterface


public interface EWSConnectorInterface


Method Summary
 java.lang.String[] createEvent(ExchangeEventDTO event)
           
 void deleteEvent(java.lang.String id, java.lang.String changeKey, java.lang.String deleteType, java.lang.String SendMeetingCancellations)
           
 void deleteItem(java.lang.String id, java.lang.String changeKey)
          The Item will be hardly deleted.
 void deleteItem(java.lang.String id, java.lang.String changeKey, java.lang.String deleteType)
           
 java.util.ArrayList getAllEvents()
           
 java.util.ArrayList getContacts()
           
 java.util.ArrayList getEmailsShalow()
          Return only the shallow information, which doesn't require second query, of all the emails in the email folder.
 ExchangeEventDTO getEventFull(java.lang.String id)
           
 java.util.ArrayList getEvents(java.util.Date startDate, java.util.Date endDate)
           
 java.util.ArrayList getPublicContacts()
           
 void setDomain(java.lang.String domain)
           
 void setFolder(java.lang.String folderName)
          set the folder for the current operation.
 void setUseNTLMAuthentication(boolean useNtlm)
          set to true if your exchange server supports only NTLM authentication.
 void updateEvent(ExchangeEventDTO event)
           
 

Method Detail

setDomain

void setDomain(java.lang.String domain)

setUseNTLMAuthentication

void setUseNTLMAuthentication(boolean useNtlm)
set to true if your exchange server supports only NTLM authentication.
when using NTLM you need also to set the domain, use the method: setDomain(String domain)

Parameters:
useNtlm - boolean

setFolder

void setFolder(java.lang.String folderName)
set the folder for the current operation.
For example "Deleted Items" for getEmails operation.
If a folder is not set, the connector will use the default value,
for the getEmails operation the default is "inbox".

Parameters:
folderName - String

getAllEvents

java.util.ArrayList getAllEvents()
                                 throws ExchangeGeneralException
Returns:
shallow information of all events as an ArrayList of ExchangeEventDTO,
to get the full information use getEventFull(eventId) method.
Throws:
ExchangeGeneralException

getEvents

java.util.ArrayList getEvents(java.util.Date startDate,
                              java.util.Date endDate)
                              throws ExchangeGeneralException
Parameters:
startDate -
endDate -
Returns:
shallow information of all events as an ArrayList of ExchangeEventDTO,
to get the full information use getEventFull(eventId) method.
Throws:
ExchangeGeneralException

getEventFull

ExchangeEventDTO getEventFull(java.lang.String id)
                              throws ExchangeGeneralException
Parameters:
id - event Id
Returns:
ExchangeEventDTO the DTO with contain all the shallow information, attendees information, and the body (description).
Throws:
ExchangeGeneralException

getContacts

java.util.ArrayList getContacts()
                                throws ExchangeGeneralException
Throws:
ExchangeGeneralException

getPublicContacts

java.util.ArrayList getPublicContacts()
                                      throws ExchangeGeneralException
Throws:
ExchangeGeneralException

getEmailsShalow

java.util.ArrayList getEmailsShalow()
                                    throws ExchangeGeneralException
Return only the shallow information, which doesn't require second query, of all the emails in the email folder.
Its done in one query to Exchange server and its the most efficient way. The ArrayList is of ExchangeEmailShallowDTO that contains only the shallow information .

Returns:
ArrayList ExchangeEmailShallowDTO
Throws:
ExchangeGeneralException

createEvent

java.lang.String[] createEvent(ExchangeEventDTO event)
                               throws ExchangeGeneralException
Parameters:
event - ExchangeEventDTO
Returns:
String[] the Id of the created event and the changeKey.
Throws:
ExchangeGeneralException

updateEvent

void updateEvent(ExchangeEventDTO event)
                 throws ExchangeGeneralException
Parameters:
event - ExchangeEventDTO
Throws:
ExchangeGeneralException

deleteItem

void deleteItem(java.lang.String id,
                java.lang.String changeKey)
                throws ExchangeGeneralException
The Item will be hardly deleted.

Parameters:
Id - The Id of the Item for delete
changeKey - The changeKey of the item for delete
Throws:
ExchangeGeneralException

deleteItem

void deleteItem(java.lang.String id,
                java.lang.String changeKey,
                java.lang.String deleteType)
                throws ExchangeGeneralException
Parameters:
Id - The Id of the Item for delete
changeKey - The changeKey of the item for delete
deleteType - you need to choose one of the following:
HardDelete: An item is permanently removed from the store.
SoftDelete: An item is moved to the dumpster if the dumpster is enabled.
MoveToDeletedItems: An item is moved to the Deleted Items folder.
Throws:
ExchangeGeneralException

deleteEvent

void deleteEvent(java.lang.String id,
                 java.lang.String changeKey,
                 java.lang.String deleteType,
                 java.lang.String SendMeetingCancellations)
                 throws ExchangeGeneralException
Parameters:
Id - The Id of the Item for delete
changeKey - The changeKey of the item for delete
deleteType - you need to choose one of the following:
HardDelete: An item is permanently removed from the store.
SoftDelete: An item is moved to the dumpster if the dumpster is enabled.
MoveToDeletedItems: An item is moved to the Deleted Items folder.
SendMeetingCancellations - you need to choose one of the following:
SendToNone: A calendar item is deleted without sending a cancellation message.
SendOnlyToAll: A calendar item is deleted and a cancellation message is sent to all attendees.
SendToAllAndSaveCopy: A calendar item is deleted and a cancellation message is sent to all attendees. A copy of the cancellation message is saved in the Sent Items folder.
Throws:
ExchangeGeneralException