org.ikasan.spec.event

Interface ManagedEventIdentifierService<IDENTIFIER,EVENT>

public interface ManagedEventIdentifierService<IDENTIFIER,EVENT>

Interface for a ManagedEventIdentifierService providing the contract for any business event identifier to be added on the creation of a business event. The Event Identifier is a business identifier immutable for the business life of the event.

Author:

Ikasan Development Team

Field Summary

Fields

Modifier and Type	Field and Description
static String	EVENT_LIFE_ID provide consistent properties for access

Method Summary

Methods

Modifier and Type	Method and Description
IDENTIFIER	getEventIdentifier(EVENT event) Get the life identifier for the incoming event.
void	setEventIdentifier(IDENTIFIER identifier, EVENT event) Set the event life identifier based on the incoming event implementation.

Field Detail

EVENT_LIFE_ID

static final String EVENT_LIFE_ID

provide consistent properties for access

See Also:

Constant Field Values

Method Detail

setEventIdentifier

void setEventIdentifier(IDENTIFIER identifier,
                      EVENT event)
                        throws ManagedEventIdentifierException

Set the event life identifier based on the incoming event implementation. The incoming identifier should always be a valid object - never 'null', although this is not enforced in the code.

Parameters:

identifier -

event -

Throws:

ManagedEventIdentifierException

getEventIdentifier

IDENTIFIER getEventIdentifier(EVENT event)
                              throws ManagedEventIdentifierException

Get the life identifier for the incoming event. This will either return a value for the life identifier or throw an exception if it cannot be obtained. This should never return 'null'.

Parameters:

event -

Returns:

IDENTIFIER

Throws:

ManagedEventIdentifierException