Package com.logicaldoc.calendar.webservice.soap.client

Class SoapCalendarClient

java.lang.Object

com.logicaldoc.webservice.soap.client.SoapClient<CalendarService>

com.logicaldoc.calendar.webservice.soap.client.SoapCalendarClient

All Implemented Interfaces:

CalendarService

public class SoapCalendarClient
extends com.logicaldoc.webservice.soap.client.SoapClient<CalendarService>
implements CalendarService

Simple client for the Calendar webservice

Since:

9.2.2

Author:

Marco Meschieri - LogicalDOC

Constructor Summary

Constructors

Constructor	Description
SoapCalendarClient(String endpoint)
SoapCalendarClient(String endpoint, int timeout)
SoapCalendarClient(String endpoint, int gzipThreshold, boolean log, int timeout)

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

Methods inherited from class java.lang.Object

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

Constructor Details

SoapCalendarClient

public SoapCalendarClient(String endpoint,
 int timeout)

SoapCalendarClient

public SoapCalendarClient(String endpoint,
 int gzipThreshold,
 boolean log,
 int timeout)

SoapCalendarClient

public SoapCalendarClient(String endpoint)

Method Details

save

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

Description copied from interface: CalendarService

Saves a calendar event

Specified by:

save in interface CalendarService

Parameters:

sid - The session identifier

event - The event to save

Returns:

The created event

Throws:

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

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

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

get

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

Description copied from interface: CalendarService

Retrieves a calendar event

Specified by:

get in interface CalendarService

Parameters:

sid - The session identifier

eventId - Identifier of the event

Returns:

The retrieved event

Throws:

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

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

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

find

public 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

Description copied from interface: CalendarService

Searches the events related to the current user

Specified by:

find in interface CalendarService

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