Package com.logicaldoc.gui.frontend.client.services

Interface CalendarService

All Superinterfaces:

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

@RemoteServiceRelativePath("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 - LogicalDOC

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	CalendarService.Instance

Method Summary

Modifier and Type	Method	Description
int	countUserEvents(String username, Date end)	Counts the number of events that start from now until a given date
void	deleteEvent(long eventId)	Deletes an event.
GUICalendarEvent[]	find(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(long eventId)	Gets an event
void	saveEvent(GUICalendarEvent event)	Saves an event into the calendar

Method Detail

saveEvent

void saveEvent(GUICalendarEvent event)
        throws ServerException

Saves an event into the calendar

Parameters:

event - the event to save

Throws:

ServerException - an error happened in the server application

getEvent

GUICalendarEvent getEvent(long eventId)
                   throws ServerException

Gets an event

Parameters:

eventId - identifier of the event

Returns:

the calendar event

Throws:

ServerException - an error happened in the server application

find

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

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:

ServerException - an error happened in the server application

deleteEvent

void deleteEvent(long eventId)
          throws ServerException

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

Parameters:

eventId - identifier of the event

Throws:

ServerException - an error happened in the server application

countUserEvents

int countUserEvents(String username,
                    Date end)
             throws ServerException

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

Parameters:

username - The user to be processed

end - The and date

Returns:

The number of found events

Throws:

ServerException - an error happened in the server application