Interface ICalendar

All Superinterfaces:
IChangelogSupport, ICountingSupport, ICrudByIdSupport<VEventSeries>, IItemChangelogSupport, IReadByIdSupport<VEventSeries>, IRestoreCrudSupport<VEventSeries>, IRestoreItemCrudSupport<VEventSeries>, IRestoreSupport<VEventSeries>, ISortingSupport
All Known Subinterfaces:
IInternalCalendar
@Path("/calendars/{containerUid}") public interface ICalendar extends IChangelogSupport, IItemChangelogSupport, ICrudByIdSupport<VEventSeries>, ICountingSupport, ISortingSupport, IRestoreItemCrudSupport<VEventSeries>
Calendar operations.

  • Method Details

    • create

      @PUT @Path("{uid}") void create(@PathParam("uid") String uid, VEventSeries event, @QueryParam("sendNotifications") Boolean sendNotifications) throws net.bluemind.core.api.fault.ServerFault
      Creates a VEvent.
      Parameters:
      uid - the unique identifier for the new event
      event - the VEventSeries to store
      sendNotifications - if true then notify attendees of this event; does not affect resource manager notifications
      Throws:
      net.bluemind.core.api.fault.ServerFault

    • update

      @POST @Path("{uid}") void update(@PathParam("uid") String uid, VEventSeries event, @QueryParam("sendNotifications") Boolean sendNotifications) throws net.bluemind.core.api.fault.ServerFault
      Updates a VEventSeries.
      Parameters:
      uid - the unique identifier of the event
      event - the VEventSeries to update
      sendNotifications - if true then notify attendees of this event; does not affect resource manager notifications
      Throws:
      net.bluemind.core.api.fault.ServerFault

    • getComplete

      @GET @Path("{uid}/complete") ItemValue<VEventSeries> getComplete(@PathParam("uid") String uid) throws net.bluemind.core.api.fault.ServerFault
      Returns the VEventSeries identified by the given unique identifier.
      Specified by:
      getComplete in interface IRestoreItemCrudSupport<VEventSeries>
      Parameters:
      uid - the unique identifier of the event
      Returns:
      a VEventSeries if successful
      Throws:
      net.bluemind.core.api.fault.ServerFault

    • getByIcsUid

      @GET @Path("_icsuid/{uid}") List<ItemValue<VEventSeries>> getByIcsUid(@PathParam("uid") String uid) throws net.bluemind.core.api.fault.ServerFault
      Returns all VEventSeries matching the given ICS unique identifier.
      Parameters:
      uid - the ICS unique identifier
      Returns:
      the list of matching VEventSeries
      Throws:
      net.bluemind.core.api.fault.ServerFault

    • multipleGet

      @POST @Path("_mget") List<ItemValue<VEventSeries>> multipleGet(List<String> uids) throws net.bluemind.core.api.fault.ServerFault
      Fetch multiple VEventSeries identified by the given unique identifiers.
      Parameters:
      uids - the list of unique identifiers
      Returns:
      all matching VEventSeries
      Throws:
      net.bluemind.core.api.fault.ServerFault

    • multipleGetByRange

      @POST @Path("_mget_range") net.bluemind.core.api.ListResult<ItemValue<VEventSeries>> multipleGetByRange(VEventRange range) throws net.bluemind.core.api.fault.ServerFault
      Fetch multiple VEventSeries identified by the given range
      Parameters:
      range - VEventRange
      Returns:
      all matching VEventSeries
      Throws:
      net.bluemind.core.api.fault.ServerFault

    • delete

      @DELETE @Path("{uid}") void delete(@PathParam("uid") String uid, @QueryParam("sendNotifications") Boolean sendNotifications) throws net.bluemind.core.api.fault.ServerFault
      Deletes the VEventSeries identified by the given unique identifier.
      Parameters:
      uid - the unique identifier of the event
      sendNotifications - if true then notify attendees of this event; does not affect resource manager notifications
      Throws:
      net.bluemind.core.api.fault.ServerFault

    • touch

      @POST @Path("{uid}/_touch") void touch(@PathParam("uid") String uid) throws net.bluemind.core.api.fault.ServerFault
      Touch a VEvent.
      Parameters:
      uid - the unique identifier of the event
      Throws:
      net.bluemind.core.api.fault.ServerFault

    • updates

      @PUT @Path("_mupdates") ContainerUpdatesResult updates(VEventChanges changes) throws net.bluemind.core.api.fault.ServerFault
      Applies changes (create, update, delete) to a calendar specified by its containerUid.
      Parameters:
      changes - the changes to apply
      Throws:
      net.bluemind.core.api.fault.ServerFault

    • search

      @POST @Path("_search") net.bluemind.core.api.ListResult<ItemValue<VEventSeries>> search(VEventQuery query) throws net.bluemind.core.api.fault.ServerFault
      Search for events matching the given query.
      Parameters:
      query - the VEventQuery to match against
      Returns:
      the matching VEventSeries
      Throws:
      net.bluemind.core.api.fault.ServerFault

    • sync

      @PUT @Path("_sync") ContainerChangeset<String> sync(@QueryParam("since") Long since, VEventChanges changes) throws net.bluemind.core.api.fault.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:
      net.bluemind.core.api.fault.ServerFault

    • list

      @GET @Path("_list") net.bluemind.core.api.ListResult<ItemValue<VEventSeries>> list() throws net.bluemind.core.api.fault.ServerFault
      List all the events of this calendar.
      Returns:
      all the VEventSeries
      Throws:
      net.bluemind.core.api.fault.ServerFault

    • reset

      @POST @Path("_reset") TaskRef reset() throws net.bluemind.core.api.fault.ServerFault
      Remove all events from this calendar.
      Returns:
      the reference to this asynchronous operation
      Throws:
      net.bluemind.core.api.fault.ServerFault

    • all

      @GET @Path("_all") List<String> all() throws net.bluemind.core.api.fault.ServerFault
      Returns all the items uid from the container.
      Returns:
      all the items uid from the container.
      Throws:
      net.bluemind.core.api.fault.ServerFault

    • isAutoSyncActivated

      @GET @Path("_isAutoSyncActivated") boolean isAutoSyncActivated() throws net.bluemind.core.api.fault.ServerFault
      Check the automatic synchronization is activated for this calendar.
      Returns:
      true if this calendar is automatically synchronized, false otherwise
      Throws:
      net.bluemind.core.api.fault.ServerFault

    • searchPendingCounters

      @GET @Path("_search_counters") net.bluemind.core.api.ListResult<ItemValue<VEventSeries>> searchPendingCounters()
      Search pending counters of the current user
      Returns: