org.exoplatform.agenda.service

Interface AgendaRemoteEventService

public interface AgendaRemoteEventService

Method Summary

Modifier and Type	Method and Description
void	addRemoteProvider(RemoteProviderDefinitionPlugin plugin) Register a new Remote provider
RemoteEvent	findRemoteEvent(long eventId, long userIdentityId) Retrieves remote event information for a given user
List<RemoteProvider>	getRemoteProviders()
RemoteEvent	saveRemoteEvent(long eventId, RemoteEvent remoteEvent, long userIdentityId) Creates or updates RemoteEvent of user
RemoteEvent	saveRemoteEvent(RemoteEvent remoteEvent) Creates or updates RemoteEvent of user
RemoteProvider	saveRemoteProvider(RemoteProvider remoteProvider) Creates a new RemoteProvider for remote events
RemoteProvider	saveRemoteProviderApiKey(String remoteProviderName, String apiKey) Save RemoteProvider Client API Key
RemoteProvider	saveRemoteProviderPlugin(RemoteProviderDefinitionPlugin plugin) Register a new Remote provider
RemoteProvider	saveRemoteProviderStatus(String remoteProviderName, boolean enabled) Save RemoteProvider status

Method Detail

addRemoteProvider

void addRemoteProvider(RemoteProviderDefinitionPlugin plugin)

Register a new Remote provider

Parameters:

plugin - RemoteProviderDefinitionPlugin

saveRemoteProviderPlugin

RemoteProvider saveRemoteProviderPlugin(RemoteProviderDefinitionPlugin plugin)

Register a new Remote provider

Parameters:

plugin - RemoteProviderDefinitionPlugin

Returns:

created RemoteProvider

getRemoteProviders

List<RemoteProvider> getRemoteProviders()

Returns:

List of available events RemoteProvider

saveRemoteProvider

RemoteProvider saveRemoteProvider(RemoteProvider remoteProvider)

Creates a new RemoteProvider for remote events

Parameters:

remoteProvider - remote provider for remote events

Returns:

created RemoteProvider

saveRemoteProviderStatus

RemoteProvider saveRemoteProviderStatus(String remoteProviderName,
                                        boolean enabled)

Save RemoteProvider status

Parameters:

remoteProviderName - Remote provider name

enabled - whether enabled (true) or disabled (false)

Returns:

saved RemoteProvider

saveRemoteProviderApiKey

RemoteProvider saveRemoteProviderApiKey(String remoteProviderName,
                                        String apiKey)

Save RemoteProvider Client API Key

Parameters:

remoteProviderName - Remote provider name

apiKey - Client API Key used to allow users access remote connector API to retrieve and change events on their accounts

Returns:

saved RemoteProvider

saveRemoteEvent

RemoteEvent saveRemoteEvent(long eventId,
                            RemoteEvent remoteEvent,
                            long userIdentityId)

Creates or updates RemoteEvent of user

Parameters:

eventId - technical identifier Event to attach to remote provider

remoteEvent - RemoteEvent with remoteId and RemoteProvider provider name information

userIdentityId - User Identity identitifer who attached event to remote provider

Returns:

created/updated RemoteEvent

saveRemoteEvent

RemoteEvent saveRemoteEvent(RemoteEvent remoteEvent)

Creates or updates RemoteEvent of user

Parameters:

remoteEvent - RemoteEvent with remoteId and RemoteProvider provider name information

Returns:

created/updated RemoteEvent

findRemoteEvent

RemoteEvent findRemoteEvent(long eventId,
                            long userIdentityId)

Retrieves remote event information for a given user

Parameters:

eventId - Event technical identifier

userIdentityId - Identity identifier

Returns:

RemoteEvent with RemoteId and RemoteProvider information