Package io.meeds.gamification.service

Interface EventService

All Known Implementing Classes:
EventServiceImpl
public interface EventService

  • Method Details

    • addPlugin

      void addPlugin(EventPlugin eventPlugin)
      Add a new EventPlugin for a given Event Type
      Parameters:
      eventPlugin - EventPlugin

    • removePlugin

      void removePlugin(String eventType)
      Removes a EventPlugin identified by its eventType
      Parameters:
      eventType - Event type

    • getEventPlugin

      EventPlugin getEventPlugin(String eventType)
      Gets a EventPlugin identified by its eventType
      Returns:
      eventPlugin EventPlugin

    • getEvents

      List<EventDTO> getEvents(EventFilter eventFilter, int offset, int limit)
      Get events by filter using offset and limit.
      Parameters:
      eventFilter - EventFilter used to filter events
      offset - Offset of result
      limit - Limit of result
      Returns:
      List of EventDTO

    • getEventsByTitle

      List<EventDTO> getEventsByTitle(String title, int offset, int limit)
      Parameters:
      title - EventDTO title
      offset - Offset of result
      limit - Limit of result
      Returns:
      List of EventDTO

    • countEvents

      int countEvents(EventFilter eventFilter)
      Parameters:
      eventFilter - EventFilter used to count associated events
      Returns:
      count events by filter

    • getEventByTitleAndTrigger

      EventDTO getEventByTitleAndTrigger(String title, String trigger)
      Get gamification event by event title and trigger name
      Parameters:
      title - event title
      trigger - trigger name
      Returns:
      EventDTO

    • createEvent

      EventDTO createEvent(EventDTO eventDTO)
      Add Event to DB
      Parameters:
      eventDTO - EventDTO to create
      Returns:
      EventDTO

    • updateEvent

      EventDTO updateEvent(EventDTO eventDTO) throws org.exoplatform.commons.exception.ObjectNotFoundException
      Update event
      Parameters:
      eventDTO - EventDTO to update
      Returns:
      updated EventDTO
      Throws:
      org.exoplatform.commons.exception.ObjectNotFoundException - when event doesn't exists

    • getEventsByCancellerTrigger

      default List<EventDTO> getEventsByCancellerTrigger(String eventType, String cancellerTrigger, int offset, int limit)
      Get events by canceller trigger
      Parameters:
      eventType - event Type
      cancellerTrigger - canceller trigger
      offset - Offset of result
      limit - Limit of result
      Returns:
      List of EventDTO

    • isVerificationRequiredForEvent

      default boolean isVerificationRequiredForEvent(String triggerType, String triggerName)
      Check if verification required
      Parameters:
      triggerType - trigger type
      triggerName - trigger name
      Returns:
      Boolean

    • getEvent

      EventDTO getEvent(long eventId)
      Retrieves gamification event by event id
      Parameters:
      eventId - Event Identifier
      Returns:
      EventDTO

    • deleteEventById

      EventDTO deleteEventById(long eventId) throws org.exoplatform.commons.exception.ObjectNotFoundException
      Deletes an existing event
      Parameters:
      eventId - Event technical identifier to delete
      Returns:
      deleted EventDTO
      Throws:
      org.exoplatform.commons.exception.ObjectNotFoundException