org.ikasan.framework.event.exclusion.service
Interface ExcludedEventService

All Known Implementing Classes:

ExcludedEventServiceImpl

public interface ExcludedEventService

Author:

The Ikasan Development Team

Method Summary

void	cancel(String eventId, String canceller) attempts to resolve an ExcludedEvent specified by id as cancelled
void	excludeEvent(Event event, String moduleName, String flowName) Exclude and Event from a specified flow
ExcludedEvent	getExcludedEvent(String eventId) Retrieve an ExcludedEvent specified by its event Id
PagedSearchResult<ExcludedEvent>	getExcludedEvents(int pageNo, int pageSize, String orderBy, boolean orderAscending, String moduleName, String flowName) Returns a paged listing of ExcludedEvent
void	resubmit(String eventId, String resubmitter) Synchronously attempts to resubmit an ExcludedEvent specified by id

Method Detail

excludeEvent

void excludeEvent(Event event,
                  String moduleName,
                  String flowName)

Exclude and Event from a specified flow

Parameters:

event -

moduleName -

flowName -

getExcludedEvents

PagedSearchResult<ExcludedEvent> getExcludedEvents(int pageNo,
                                                   int pageSize,
                                                   String orderBy,
                                                   boolean orderAscending,
                                                   String moduleName,
                                                   String flowName)

Returns a paged listing of ExcludedEvent

Parameters:

pageNo - - 0 or greater, index into the list of all possible results

pageSize - - 0 or greater, no of excludedEvents to return on a page

orderBy - - field to order by

orderAscending - - in ascending order?

flowName - - restrict by flowName if supplied

moduleName - - restrict by moduleName if supplied

Returns:

PagedSearchResult

getExcludedEvent

ExcludedEvent getExcludedEvent(String eventId)

Retrieve an ExcludedEvent specified by its event Id

Parameters:

eventId -

Returns:

ExcludedEvent

resubmit

void resubmit(String eventId,
              String resubmitter)

Synchronously attempts to resubmit an ExcludedEvent specified by id

Parameters:

eventId -

resubmitter -

Throws:

IllegalArgumentException - if ExcludedEvent cannot be found, or if referenced module or flow are not available

cancel

void cancel(String eventId,
            String canceller)

attempts to resolve an ExcludedEvent specified by id as cancelled

Parameters:

eventId -

canceller -

Throws:

IllegalArgumentException - if ExcludedEvent cannot be found, or if referenced module or flow are not available