Package com.logicaldoc.calendar.webservice.soap

Interface CalendarService

All Known Implementing Classes:

SoapCalendarClient, SoapCalendarService

public interface CalendarService

WebService to allow interaction with the user's calendar

Since:

9.2.2

Author:

Marco Meschieri - LogicalDOC

Method Summary

Modifier and Type	Method	Description
List<WSEvent>	find(String sid, String startFrom, String startTo, String title, boolean initialize)	Searches the events related to the current user
WSEvent	get(String sid, long eventId)	Retrieves a calendar event
WSEvent	save(String sid, WSEvent event)	Saves a calendar event

Method Details

save

WSEvent save(String sid,
 WSEvent event)
      throws com.logicaldoc.core.security.authentication.AuthenticationException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException

Saves a calendar event

Parameters:

sid - The session identifier

event - The event to save

Returns:

The created event

Throws:

com.logicaldoc.core.PersistenceException - Error in the data layer

com.logicaldoc.webservice.WebserviceException - Error in the webservice

com.logicaldoc.core.security.authentication.AuthenticationException - The user has not been authenticated

get

WSEvent get(String sid,
 long eventId)
     throws com.logicaldoc.core.security.authentication.AuthenticationException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException

Retrieves a calendar event

Parameters:

sid - The session identifier

eventId - Identifier of the event

Returns:

The retrieved event

Throws:

com.logicaldoc.core.PersistenceException - Error in the data layer

com.logicaldoc.webservice.WebserviceException - Error in the webservice

com.logicaldoc.core.security.authentication.AuthenticationException - The user has not been authenticated

find

List<WSEvent> find(String sid,
 String startFrom,
 String startTo,
 String title,
 boolean initialize)
            throws com.logicaldoc.core.security.authentication.AuthenticationException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException

Searches the events related to the current user

Parameters:

sid - The session identifier

startFrom - lower limit for the start date

startTo - upper limit for the start date

title - title of the event

initialize - if the events must be fully initialized

Returns:

the list of found events

Throws:

com.logicaldoc.core.security.authentication.AuthenticationException

com.logicaldoc.webservice.WebserviceException

com.logicaldoc.core.PersistenceException