Class ReminderResource

    • Constructor Detail

      • ReminderResource

        public ReminderResource()
    • Method Detail

      • getPossibleDurations

        @Path("possibledurations/{property}")
        @GET
        @Produces("application/json")
        public List<String> getPossibleDurations​(@PathParam("property")
                                                 String contributionProperty)
        Gets the identifier list of possible of durations.

        An identifier of a duration is the concatenation about the duration value and the duration unit (TimeUnit).
        15MINUTE for example.

        Returns:
        a filled list if any, or an empty one if no trigger can be scheduled.
        See Also:
        RESTWebService.WebProcess.execute()
      • getReminders

        @GET
        @Produces("application/json")
        public List<ReminderEntity> getReminders()
        Gets the JSON representation of a list of reminder. If it doesn't exist, a 404 HTTP code is returned.
        Returns:
        the response to the HTTP GET request with the JSON representation of the asked reminders.
        See Also:
        RESTWebService.WebProcess.execute()
      • createReminder

        @POST
        @Produces("application/json")
        public ReminderEntity createReminder​(ReminderEntity reminderEntity)
        Creates the reminder from its JSON representation and returns it once created.
        If the user isn't authenticated, a 401 HTTP code is returned. If the user isn't authorized to save the reminder, a 403 is returned. If a problem occurs when processing the request, a 503 HTTP code is returned.
        Parameters:
        reminderEntity - the reminder data
        Returns:
        the response to the HTTP POST request with the JSON representation of the created reminder.
      • updateReminder

        @Path("{id}")
        @PUT
        @Produces("application/json")
        public ReminderEntity updateReminder​(@PathParam("id")
                                             String id,
                                             ReminderEntity reminderEntity)
        Updates the reminder from its JSON representation and returns it once updated.
        If the user isn't authenticated, a 401 HTTP code is returned. If the user isn't authorized to save the reminder, a 403 is returned. If a problem occurs when processing the request, a 503 HTTP code is returned.
        Parameters:
        id - a reminder identifier, the one of reminderEntity
        reminderEntity - the reminder data
        Returns:
        the response to the HTTP POST request with the JSON representation of the updated reminder.
      • deleteReminder

        @DELETE
        @Path("{id}")
        @Produces("application/json")
        public void deleteReminder​(@PathParam("id")
                                   String id)
        Deletes the given reminder from its JSON representation.
        If the user isn't authenticated, a 401 HTTP code is returned. If the user isn't authorized to delete the reminder, a 403 is returned. If a problem occurs when processing the request, a 503 HTTP code is returned.
        Parameters:
        id - a reminder identifier
      • getComponentId

        public String getComponentId()
        Description copied from interface: SilverpeasWebResource
        Gets the identifier of the component instance to which the requested resource belongs to.
        Returns:
        the identifier of the Silverpeas component instance.