com.groundwork.collage
Interface CollageEventQuery

public interface CollageEventQuery

Gets logged events for different entities in the Collage database.

Version:

$Id: CollageEventQuery.java,v 1.6 2005/07/27 21:32:37 rogerrut Exp $

Author:

Robin Dandridge

Method Summary

java.util.Collection	getEventsByDate(java.lang.String timeField, java.util.Date fromDate, java.util.Date toDate) Returns a collection of LogMessage for a given date range.
java.util.Collection	getEventsForDevice(java.lang.String identification, java.lang.String timeField, java.util.Date fromDate, java.util.Date toDate) Returns a collection of LogMessage for a given device identification
java.util.Collection	getEventsForHost(java.lang.String HostName, java.lang.String timeField, java.util.Date fromDate, java.util.Date toDate) Returns a collection of LogMessage for a given host
java.util.Collection	getEventsForHostGroup(java.lang.String hostGroupName, java.lang.String timeField, java.util.Date fromDate, java.util.Date toDate) Returns a collection of LogMessage for a given HostGroup.
java.util.Collection	getEventsForService(java.lang.String serviceDescription, java.lang.String HostName, java.lang.String timeField, java.util.Date fromDate, java.util.Date toDate) Returns a collection of LogMessage for a given ServiceDescription and Host name

Method Detail

getEventsForDevice

public java.util.Collection getEventsForDevice(java.lang.String identification,
                                               java.lang.String timeField,
                                               java.util.Date fromDate,
                                               java.util.Date toDate)
                                        throws CollageException

Returns a collection of LogMessage for a given device identification

Parameters:

identification -

timeField - String that is either FirstInsertDate or LastInsertDate or NULL if no time limit should be applied.

fromDate - Beginning of date Range

toDate - End of date range

Returns:

Collection of LogMessage matching the time range and the identification.

Throws:

CollageException

getEventsForService

public java.util.Collection getEventsForService(java.lang.String serviceDescription,
                                                java.lang.String HostName,
                                                java.lang.String timeField,
                                                java.util.Date fromDate,
                                                java.util.Date toDate)
                                         throws CollageException

Returns a collection of LogMessage for a given ServiceDescription and Host name

Parameters:

serviceDescription -

timeField - String that is either FirstInsertDate or LastInsertDate or NULL if no time limit should be applied.

fromDate - Beginning of date Range

toDate - End of date range

Returns:

Collection of LogMessage matching the time range, Host name and ServiceDescription.

Throws:

CollageException

getEventsForHost

public java.util.Collection getEventsForHost(java.lang.String HostName,
                                             java.lang.String timeField,
                                             java.util.Date fromDate,
                                             java.util.Date toDate)
                                      throws CollageException

Returns a collection of LogMessage for a given host

Parameters:

timeField - String that is either FirstInsertDate or LastInsertDate or NULL if no time limit should be applied.

fromDate - Beginning of date Range

toDate - End of date range

Returns:

Collection of LogMessage matching the time range and the Host name.

Throws:

CollageException

getEventsForHostGroup

public java.util.Collection getEventsForHostGroup(java.lang.String hostGroupName,
                                                  java.lang.String timeField,
                                                  java.util.Date fromDate,
                                                  java.util.Date toDate)
                                           throws CollageException

Returns a collection of LogMessage for a given HostGroup. This means that all LogMessages (events) within the specified time range (or all events if null is passed for the timeField parameter) for all services and hosts in the HostGroup will be returned.

Parameters:

hostGroupName -

timeField - String that is either FirstInsertDate or LastInsertDate or NULL if no time limit should be applied.

fromDate - Beginning of date Range

toDate - End of date range

Returns:

Collection of LogMessage matching the time range and the Host name.

Throws:

CollageException

getEventsByDate

public java.util.Collection getEventsByDate(java.lang.String timeField,
                                            java.util.Date fromDate,
                                            java.util.Date toDate)
                                     throws CollageException

Returns a collection of LogMessage for a given date range. This means that all events withing the specified date range for all Services and Hosts will be returned.

Parameters:

timeField - String that is either FirstInsertDate or LastInsertDate or NULL if no time limit should be applied.

fromDate - Beginning of date Range

toDate - End of date range

Returns:

Collection of LogMessage matching the time range and the Host name.

Throws:

CollageException