com.logicaldoc.gui.frontend.client.services

Interface CalendarService

All Superinterfaces:

com.google.gwt.user.client.rpc.RemoteService

@RemoteServiceRelativePath(value="calendar")
public interface CalendarService
extends com.google.gwt.user.client.rpc.RemoteService

The client side stub for the Calendar Service. This service allows the handling of calendar events.

Since:

6.7

Author:

Marco Meschieri - Logical Objects

Method Summary

Methods

Modifier and Type	Method and Description
int	countUserEvents(String sid, Date end) Counts the number of events that start from now until a given date.
void	deleteEvent(String sid, long eventId) Deletes an event.
GUICalendarEvent[]	find(String sid, Date startDate, Date endDate, Date expireFrom, Date expireTo, Integer frequency, String title, String type, String subtype, Integer status, Integer maxRecords) Searches for events.
GUICalendarEvent	getEvent(String sid, long eventId) Gets an event
void	saveEvent(String sid, GUICalendarEvent event) Saves an event

Method Detail

saveEvent

void saveEvent(String sid,
             GUICalendarEvent event)
               throws InvalidSessionException

Saves an event

Throws:

InvalidSessionException

getEvent

GUICalendarEvent getEvent(String sid,
                        long eventId)
                          throws InvalidSessionException

Gets an event

Throws:

InvalidSessionException

find

GUICalendarEvent[] find(String sid,
                      Date startDate,
                      Date endDate,
                      Date expireFrom,
                      Date expireTo,
                      Integer frequency,
                      String title,
                      String type,
                      String subtype,
                      Integer status,
                      Integer maxRecords)
                        throws InvalidSessionException

Searches for events.

Parameters:

startDate - Start date (optional)

endDate - End date (optional)

expireFrom - (optional)

expireTo - (optional)

frequency - The frequency of the event (1,15, 30 ... optional)

title - The title (used with like operator, optional)

type - The type (used with like operator, optional)

subtype - The subtype (used with like operator, optional)

status - The title (used with like operator, optional)

maxRecords - Maximum number of records (optional)

Returns:

The list of events ordered by ascending date

Throws:

InvalidSessionException

deleteEvent

void deleteEvent(String sid,
               long eventId)
                 throws InvalidSessionException

Deletes an event. If the event is a master, in any case all the occurrences will be deleted too.

Throws:

InvalidSessionException

countUserEvents

int countUserEvents(String sid,
                  Date end)
                    throws InvalidSessionException

Counts the number of events that start from now until a given date.

Parameters:

sid - The session identifier

end - The and date

Returns:

The number of found events

Throws:

InvalidSessionException