com.neurosys.events.service

Interface EventBasedService<R,P>

Type Parameters:

R - as type of event response/result

P - as event params

public interface EventBasedService<R,P>

Any process like Validation or notification that may involve events that are asynchronous in relation to a User and notification related
The event service is internally responsible for event generation & notification. One can use Listeners like ChangeListener and ChangeGenerator for more fine grained event/listener handling. This interface is for a service definition of the API exposed and all internal event handling details should remain encapsulated.

Author:

Arjun Dhar

Method Summary

Modifier and Type	Method and Description
R	event(String id, String eventType, P eventParams) A process that will notify/validate/inform a User immediately If the validation cannot be performed for any reason an Exception will be thrown.
String	initEvent(String id, String eventType, P eventParams) A process that will initiate the process Asynchronously/Offline and return a String as UID to identify the result of the process.
void	onEventFail(String id, String UID, Exception e) When the process of validation completes this method is called.
void	onEventSuccess(String id, String UID, R result, String details) When the process of validation completes/success this method is called.

Method Detail

event

R event(String id,
        String eventType,
        P eventParams)
 throws Exception

A process that will notify/validate/inform a User immediately
If the validation cannot be performed for any reason an Exception will be thrown.

Parameters:

id - as String (like for a user a userId)

eventType - as String (implementation specific. JSON or a single value String)

eventParams - as P

Returns:

boolean

Throws:

Exception

initEvent

String initEvent(String id,
                 String eventType,
                 P eventParams)

A process that will initiate the process Asynchronously/Offline and return a String as UID to identify the result of the process.

Parameters:

id - as String (like for a user a userId)

eventType - as String

eventParams - as P

Returns:

String as UID

onEventSuccess

void onEventSuccess(String id,
                    String UID,
                    R result,
                    String details)

When the process of validation completes/success this method is called.

Parameters:

id - as String (like for a user a userId)

UID - as String

result - as T

details - as Details as Exception or any other details about validation result

onEventFail

void onEventFail(String id,
                 String UID,
                 Exception e)

When the process of validation completes this method is called.

Parameters:

id - as String (like for a user a userId)

UID - as String

e - as Exception that resulted in Failure