net.bluemind.calendar.api

Interface ICalendar

All Superinterfaces:

IChangelogSupport

All Known Subinterfaces:

IInternalCalendar

All Known Implementing Classes:

CalendarAuditProxy, CalendarService

@Path(value="/calendars/{containerUid}")
public interface ICalendar
extends IChangelogSupport

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	all() Returns all the items uid from the container
void	create(java.lang.String uid, VEventSeries event, java.lang.Boolean sendNotifications) Creates a VEvent
void	createById(long id, VEventSeries event, java.lang.Boolean sendNotifications)
void	delete(java.lang.String uid, java.lang.Boolean sendNotifications) Deletes a VEvent
java.util.List<ItemValue<VEventSeries>>	getByIcsUid(java.lang.String uid) Returns VEventSeries
ItemValue<VEventSeries>	getComplete(java.lang.String uid) Returns a VEvent
boolean	isAutoSyncActivated() Check the automatic synchronization is activated for this calendar.
ListResult<ItemValue<VEventSeries>>	list()
java.util.List<ItemValue<VEventSeries>>	multipleGet(java.util.List<java.lang.String> uids) Fetch multiple VEvents from theirs uniques uids
TaskRef	reset() Remove all events from this calendar.
ListResult<ItemValue<VEventSeries>>	search(VEventQuery query) Returns a ListResult of ItemValue of VEvent
ContainerChangeset<java.lang.String>	sync(java.lang.Long since, VEventChanges changes) CLIENT_WIN style
void	touch(java.lang.String uid) Touch an VEvent
void	update(java.lang.String uid, VEventSeries event, java.lang.Boolean sendNotifications) Updates a VEvent
ContainerUpdatesResult	updates(VEventChanges changes) Applies changes (create, update, delete) to a calendar specified by its containerUid.

Methods inherited from interface net.bluemind.core.container.api.IChangelogSupport

changeset, changesetById, containerChangelog, getVersion, itemChangelog

Method Detail

create

@PUT
 @Path(value="{uid}")
void create(@PathParam(value="uid")
                                       java.lang.String uid,
                                       VEventSeries event,
                                       @QueryParam(value="sendNotifications")
                                       java.lang.Boolean sendNotifications)
                                throws ServerFault

Creates a VEvent

Parameters:

uid -

event -

sendNotifications -

Throws:

ServerFault

createById

@PUT
 @Path(value="_byId")
void createById(@QueryParam(value="id")
                                           long id,
                                           VEventSeries event,
                                           @QueryParam(value="sendNotifications")
                                           java.lang.Boolean sendNotifications)
                                    throws ServerFault

Throws:

ServerFault

update

@POST
 @Path(value="{uid}")
void update(@PathParam(value="uid")
                                        java.lang.String uid,
                                        VEventSeries event,
                                        @QueryParam(value="sendNotifications")
                                        java.lang.Boolean sendNotifications)
                                 throws ServerFault

Updates a VEvent

Parameters:

uid -

event -

sendNotifications -

Throws:

ServerFault

getComplete

@GET
 @Path(value="{uid}/complete")
ItemValue<VEventSeries> getComplete(@PathParam(value="uid")
                                                                        java.lang.String uid)
                                                                 throws ServerFault

Returns a VEvent

Parameters:

uid -

Returns:

if successful, this method return a VEvent

Throws:

ServerFault

getByIcsUid

@GET
 @Path(value="_icsuid/{uid}")
java.util.List<ItemValue<VEventSeries>> getByIcsUid(@PathParam(value="uid")
                                                                                       java.lang.String uid)
                                                                                throws ServerFault

Returns VEventSeries

Parameters:

uid - VEventSeries.icsUid

Returns:

if successful, this method return a VEvent

Throws:

ServerFault

multipleGet

@POST
 @Path(value="_mget")
java.util.List<ItemValue<VEventSeries>> multipleGet(java.util.List<java.lang.String> uids)
                                                                         throws ServerFault

Fetch multiple VEvents from theirs uniques uids

Parameters:

uids -

Returns:

List>

Throws:

ServerFault

delete

@DELETE
 @Path(value="{uid}")
void delete(@PathParam(value="uid")
                                          java.lang.String uid,
                                          @QueryParam(value="sendNotifications")
                                          java.lang.Boolean sendNotifications)
                                   throws ServerFault

Deletes a VEvent

Parameters:

uid -

sendNotifications -

Throws:

ServerFault

touch

@POST
 @Path(value="{uid}/_touch")
void touch(@PathParam(value="uid")
                                              java.lang.String uid)
                                       throws ServerFault

Touch an VEvent

Parameters:

uid -

Throws:

ServerFault

updates

@PUT
 @Path(value="_mupdates")
ContainerUpdatesResult updates(VEventChanges changes)
                                                       throws ServerFault

Applies changes (create, update, delete) to a calendar specified by its containerUid.

Parameters:

changes -

Throws:

ServerFault

search

@POST
 @Path(value="_search")
ListResult<ItemValue<VEventSeries>> search(VEventQuery query)
                                                                  throws ServerFault

Returns a ListResult of ItemValue of VEvent

Parameters:

query -

Returns:

Throws:

ServerFault

sync

@PUT
 @Path(value="_sync")
ContainerChangeset<java.lang.String> sync(@QueryParam(value="since")
                                                                     java.lang.Long since,
                                                                     VEventChanges changes)
                                                              throws ServerFault

CLIENT_WIN style

Parameters:

since -

changes -

Returns:

Throws:

ServerFault

list

@GET
 @Path(value="_list")
ListResult<ItemValue<VEventSeries>> list()
                                                             throws ServerFault

Returns:

Throws:

ServerFault

reset

@POST
 @Path(value="_reset")
TaskRef reset()
                                    throws ServerFault

Remove all events from this calendar.

Returns:

the reference to this asynchronous operation

Throws:

ServerFault

all

@GET
 @Path(value="_all")
java.util.List<java.lang.String> all()
                                                        throws ServerFault

Returns all the items uid from the container

Returns:

Throws:

ServerFault

isAutoSyncActivated

@GET
 @Path(value="_isAutoSyncActivated")
boolean isAutoSyncActivated()
                                                               throws ServerFault

Check the automatic synchronization is activated for this calendar.

Returns:

true if this calendar is automatically synchronized, false otherwise

Throws:

ServerFault