org.ametys.plugins.repository.events

Interface EventType

All Known Implementing Classes:

CalendarEventCreatedOrUpdatedEventType, CalendarsEventType, DefaultEventType, DocumentsEventType, MemberAddedEventType, PostCreatedEventType, ProjectsEventType, ResourceCreatedOrUpdatedEventType, ResourceRenamedEventType, TaskAssignedEventType, TasksEventType, TaskStatusChangedEventType, ThreadCreatedEventType, ThreadsEventType, WikiEventType, WikiPageCreatedEventType, WikiPageDeletedEventType, WikiPageRenamedEventType, WikiPageUpdatedEventType, WorkspacesEventType

public interface EventType

Interface for event types

Field Summary

Fields

Modifier and Type	Field and Description
static String	EVENT_AUTHOR Constants for event's author property
static String	EVENT_DATE Constants for event's date property
static String	EVENT_TYPE Constants for event's type property

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	event2JSON(Node eventNode) Format an event node to JSON
Map<String,I18nizableText>	getSupportedTypes() Get the ids of the supported event types
boolean	isMergeable(Map<String,Object> event1, Map<String,Object> event2) Determines if two events can be merged
Map<String,Object>	mergeEvents(List<Map<String,Object>> events) Merge events into one event.
Node	storeEvent(String eventId, Map<String,Object> parameters, EventHolder eventHolder) Store an event with the given event id under the given event holder node

Field Detail

EVENT_DATE

static final String EVENT_DATE

Constants for event's date property

See Also:

Constant Field Values

EVENT_TYPE

static final String EVENT_TYPE

Constants for event's type property

See Also:

Constant Field Values

EVENT_AUTHOR

static final String EVENT_AUTHOR

Constants for event's author property

See Also:

Constant Field Values

Method Detail

getSupportedTypes

Map<String,I18nizableText> getSupportedTypes()

Get the ids of the supported event types

Returns:

the ids of the supported event types

storeEvent

Node storeEvent(String eventId,
                Map<String,Object> parameters,
                EventHolder eventHolder)
         throws RepositoryException

Store an event with the given event id under the given event holder node

Parameters:

eventId - the id of the event to store

parameters - the event parameters

eventHolder - the event holder

Returns:

the stored node

Throws:

RepositoryException - if an error occurs while manipulating the repository

event2JSON

Map<String,Object> event2JSON(Node eventNode)
                       throws RepositoryException

Format an event node to JSON

Parameters:

eventNode - the node of an event

Returns:

the JSON for the node

Throws:

RepositoryException - if an error occurs while manipulating the repository

isMergeable

boolean isMergeable(Map<String,Object> event1,
                    Map<String,Object> event2)

Determines if two events can be merged

Parameters:

event1 - The first event

event2 - The second event

Returns:

true if the events can be merged

mergeEvents

Map<String,Object> mergeEvents(List<Map<String,Object>> events)

Merge events into one event. Be careful : be sure that the events can be merged calling isMergeable method before

Parameters:

events - The events to merge

Returns:

Merged event