net.bluemind.calendar.api

Interface ICalendar

All Superinterfaces:

IChangelogSupport, ICountingSupport, ICrudByIdSupport<VEventSeries>, IDataShardSupport, ISortingSupport

All Known Subinterfaces:

IInternalCalendar

All Known Implementing Classes:

CalendarAuditProxy, CalendarService

@Path(value="/calendars/{containerUid}")
public interface ICalendar
extends IChangelogSupport, ICrudByIdSupport<VEventSeries>, ICountingSupport, ISortingSupport, IDataShardSupport

Calendar operations.

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.
Ack	createById(long id, VEventSeries event) Creates a VEventSeries.
void	delete(java.lang.String uid, java.lang.Boolean sendNotifications) Deletes the VEventSeries identified by the given unique identifier.
void	deleteById(long id) Delete the event identified by the given item identifier.
java.util.List<ItemValue<VEventSeries>>	getByIcsUid(java.lang.String uid) Returns all VEventSeries matching the given ICS unique identifier.
ItemValue<VEventSeries>	getComplete(java.lang.String uid) Returns the VEventSeries identified by the given unique identifier.
ItemValue<VEventSeries>	getCompleteById(long id) Retrieve the VEventSeries identified by the given identifier.
boolean	isAutoSyncActivated() Check the automatic synchronization is activated for this calendar.
ListResult<ItemValue<VEventSeries>>	list() List all the events of this calendar.
java.util.List<ItemValue<VEventSeries>>	multipleGet(java.util.List<java.lang.String> uids) Fetch multiple VEventSeries identified by the given unique identifiers.
java.util.List<ItemValue<VEventSeries>>	multipleGetById(java.util.List<java.lang.Long> ids) Fetch multiple VEventSeries from theirs uniques ids
TaskRef	reset() Remove all events from this calendar.
ListResult<ItemValue<VEventSeries>>	search(VEventQuery query) Search for events matching the given query.
ListResult<ItemValue<VEventSeries>>	searchPendingCounters() Search pending counters of the current user
java.util.List<java.lang.Long>	sortedIds(SortDescriptor sorted) Sort the events item identifiers in function of the given SortDescriptor.
ContainerChangeset<java.lang.String>	sync(java.lang.Long since, VEventChanges changes) Apply the given changes and return the differences since the given time.
void	touch(java.lang.String uid) Touch a VEvent.
void	update(java.lang.String uid, VEventSeries event, java.lang.Boolean sendNotifications) Updates a VEventSeries.
Ack	updateById(long id, VEventSeries value) Update the event identified by the given item identifier.
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

allIds, changeset, changesetById, containerChangelog, filteredChangesetById, getVersion, itemChangelog

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

multipleDeleteById

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

count

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

xfer

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 - the unique identifier for the new event

event - the VEventSeries to store

sendNotifications - if true then notify this event creation on the events bus

Throws:

ServerFault

updateById

@POST
 @Path(value="id/{id}")
Ack updateById(@PathParam(value="id")
                                             long id,
                                             VEventSeries value)

Update the event identified by the given item identifier.

Specified by:

updateById in interface ICrudByIdSupport<VEventSeries>

Parameters:

id - the item identifier of the VEventSeries

value - the new value to set

Returns:

the acknowledgement object with the new version of the updated item

deleteById

@DELETE
 @Path(value="id/{id}")
void deleteById(@PathParam(value="id")
                                                long id)

Delete the event identified by the given item identifier.

Specified by:

deleteById in interface ICrudByIdSupport<VEventSeries>

Parameters:

the - item identifier of the VEventSeries

createById

@PUT
 @Path(value="id/{id}")
Ack createById(@PathParam(value="id")
                                            long id,
                                            VEventSeries event)
                                     throws ServerFault

Creates a VEventSeries.

Specified by:

createById in interface ICrudByIdSupport<VEventSeries>

Parameters:

id - the item identifier of the VEventSeries

event - the VEventSeries to store

Returns:

the acknowledgement object with the new version of the updated item

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 VEventSeries.

Parameters:

uid - the unique identifier of the event

event - the VEventSeries to update

sendNotifications - if true then notify this event creation on the events bus

Throws:

ServerFault

getComplete

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

Returns the VEventSeries identified by the given unique identifier.

Parameters:

uid - the unique identifier of the event

Returns:

a VEventSeries if successful

Throws:

ServerFault

getByIcsUid

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

Returns all VEventSeries matching the given ICS unique identifier.

Parameters:

uid - the ICS unique identifier

Returns:

the list of matching VEventSeries

Throws:

ServerFault

getCompleteById

@GET
 @Path(value="{id}/completeById")
ItemValue<VEventSeries> getCompleteById(@PathParam(value="id")
                                                                               long id)

Retrieve the VEventSeries identified by the given identifier.

Specified by:

getCompleteById in interface ICrudByIdSupport<VEventSeries>

Parameters:

id - the identifier of the event

Returns:

a VEventSeries if successfulSortDescriptor

multipleGet

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

Fetch multiple VEventSeries identified by the given unique identifiers.

Parameters:

uids - the list of unique identifiers

Returns:

all matching VEventSeries

Throws:

ServerFault

multipleGetById

@POST
 @Path(value="_mgetById")
java.util.List<ItemValue<VEventSeries>> multipleGetById(java.util.List<java.lang.Long> ids)
                                                                                 throws ServerFault

Fetch multiple VEventSeries from theirs uniques ids

Parameters:

ids - the list of unique id

Returns:

all matching VEventSeries

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 the VEventSeries identified by the given unique identifier.

Parameters:

uid - the unique identifier of the event

sendNotifications - if true then notify this event deletion on the events bus

Throws:

ServerFault

touch

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

Touch a VEvent.

Parameters:

uid - the unique identifier of the event

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 - the changes to apply

Throws:

ServerFault

search

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

Search for events matching the given query.

Parameters:

query - the VEventQuery to match against

Returns:

the matching VEventSeries

Throws:

ServerFault

sync

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

Apply the given changes and return the differences since the given time. CLIENT_WIN style.

Parameters:

since - the time from wich compare changes

changes - the changes to apply

Returns:

the ContainerChangeset of the difSortDescriptorferences

Throws:

ServerFault

list

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

List all the events of this calendar.

Returns:

all the VEventSeries

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:

all the items uid from the container.

Throws:

ServerFault

sortedIds

@POST
 @Path(value="_sorted")
java.util.List<java.lang.Long> sortedIds(SortDescriptor sorted)
                                                                throws ServerFault

Sort the events item identifiers in function of the given SortDescriptor.

Specified by:

sortedIds in interface ISortingSupport

Parameters:

the - sort directive

Returns:

the sorted event items identifiers

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

searchPendingCounters

@GET
 @Path(value="_search_counters")
ListResult<ItemValue<VEventSeries>> searchPendingCounters()

Search pending counters of the current user

Returns: