org.ikasan.framework.systemevent.service
Interface SystemEventService

All Known Implementing Classes:

SystemEventServiceImpl

public interface SystemEventService

SystemEvent service interface

Author:

Ikasan Development Team

Method Summary

void	housekeep() Cleanup all expired system events
PagedSearchResult<SystemEvent>	listSystemEvents(int pageNo, int pageSize, String orderBy, boolean orderAscending, String subject, String action, Date timestampFrom, Date timestampTo, String actor) Performs a paged search for SystemEvents restricting by criteria fields as supplied
void	logSystemEvent(String subject, String action, String actor) Logs some system level happening

Method Detail

logSystemEvent

void logSystemEvent(String subject,
                    String action,
                    String actor)

Logs some system level happening

Parameters:

subject - - system level entity that has been affected

action - - what has happened

actor - - who/what was driving the happening

listSystemEvents

PagedSearchResult<SystemEvent> listSystemEvents(int pageNo,
                                                int pageSize,
                                                String orderBy,
                                                boolean orderAscending,
                                                String subject,
                                                String action,
                                                Date timestampFrom,
                                                Date timestampTo,
                                                String actor)

Performs a paged search for SystemEvents restricting by criteria fields as supplied

Parameters:

pageNo - - page control field - page no of results to return

pageSize - - page control field - size of page

orderBy - - page control - field to order by

orderAscending - - page control field - true/false results in ascending order with respect to orderBy field

subject - - criteria field - filter for exact match on subject

action - - criteria field - filter for exact match on action

timestampFrom - - criteria field - filter for events with timestamp greater than this value

timestampTo - - criteria field - filter for events with timestamp less than this value

actor - - criteria field - filter for exact match on actor

Returns:

PagedSearchResult - page friendly search result subset

housekeep

void housekeep()

Cleanup all expired system events