com.endeca.infront.event

Interface Event

public interface Event

Represents some event that happens in the Assembler.

Method Summary

Methods

Modifier and Type	Method and Description
void	fail() Indicates that the event has completed with an error.
void	fail(Map<String,Object> properties) Indicates that the event has completed with an error.
void	failIfNotCompleted() Indicates that the event has experienced an error unless succeed has already been called (useful for calling in finally blocks).
void	failIfNotCompleted(Map<String,Object> properties) Indicates that the event has experienced an error unless succeed has already been called (useful for calling in finally blocks).
String	getTopic()
void	succeed() Indicates that the event has completed successfully.
void	succeed(Map<String,Object> properties) Indicates that the event has completed successfully.

Method Detail

getTopic

String getTopic()

Returns:

The topic (or type) of the event

succeed

void succeed()

Indicates that the event has completed successfully.

Throws:

IllegalStateException - if succeed or fail have already been called

succeed

void succeed(Map<String,Object> properties)

Indicates that the event has completed successfully.

Parameters:

properties - Any properties associated with the successful completion of the event

Throws:

IllegalStateException - if succeed or fail have already been called

fail

void fail()

Indicates that the event has completed with an error.

Throws:

IllegalStateException - if succeed or fail have already been called

fail

void fail(Map<String,Object> properties)

Indicates that the event has completed with an error.

Parameters:

properties - Any properties associated with the failure of the event

Throws:

IllegalStateException - if succeed or fail have already been called

failIfNotCompleted

void failIfNotCompleted()

Indicates that the event has experienced an error unless succeed has already been called (useful for calling in finally blocks).

failIfNotCompleted

void failIfNotCompleted(Map<String,Object> properties)

Indicates that the event has experienced an error unless succeed has already been called (useful for calling in finally blocks).

Parameters:

properties - Any properties associated with the failure of the event