com.groundwork.collage
Interface CollageHostGroupQuery

public interface CollageHostGroupQuery

Provides access to the HostGroups stored in the Collage database. Provides information pertaining to those HostGroups.

Version:

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

Author:

Robin Dandridge

Method Summary

HostGroup	getHostGroup(java.lang.String hgName) Returns a specific HostGroup; performs shallow retrieval of HostGroup, where only Name/Description of HostGroups is retrieved
HostGroup	getHostGroup(java.lang.String hgName, boolean deep) Returns a specific HostGroup; if instructed, performs deep retrieval of HostGroup, which includes all Hosts, and their HostStatus and ServiceStatuses
java.util.Collection	getHostGroups() Returns all HostGroups currently stored in the Collage database.
java.util.Collection	getHostsForHostGroup(java.lang.String hostGroup) Returns all Hosts for the given HostGroup.
java.util.Collection	getServicesForHostGroup(java.lang.String hostGroup) Returns all Services for the given HostGroup.

Method Detail

getServicesForHostGroup

public java.util.Collection getServicesForHostGroup(java.lang.String hostGroup)
                                             throws CollageException

Returns all Services for the given HostGroup. The returned Collection contains an ordered Collection of ServiceStatus.

Parameters:

hostGroup - Name of the HostGroup. Limit the query to filter by this host group.

Returns:

Collection of ServiceStatus objects for the given HostGroup.

Throws:

CollageException - when an error occurs.

getHostsForHostGroup

public java.util.Collection getHostsForHostGroup(java.lang.String hostGroup)
                                          throws CollageException

Returns all Hosts for the given HostGroup. The returned Collection contains an ordered Collection of Host.

Parameters:

hostGroup - Name of the HostGroup. Limit the query to filter by this HostGroup.

Returns:

a Collection of HostStatus objects for the given HostGroup.

Throws:

CollageException - when an error occurs.

getHostGroups

public java.util.Collection getHostGroups()
                                   throws CollageException

Returns all HostGroups currently stored in the Collage database. The returned Collection contains an ordered Collection of HostGroup.

Returns:

a Collection of all of the HostGroup objects currently in the system.

Throws:

CollageException - when an error occurs.

getHostGroup

public HostGroup getHostGroup(java.lang.String hgName)
                       throws CollageException

Returns a specific HostGroup; performs shallow retrieval of HostGroup, where only Name/Description of HostGroups is retrieved

Parameters:

hgName - The HostGroup to find

Returns:

the HostGroup requested or null if it is not found

Throws:

CollageException

getHostGroup

public HostGroup getHostGroup(java.lang.String hgName,
                              boolean deep)
                       throws CollageException

Returns a specific HostGroup; if instructed, performs deep retrieval of HostGroup, which includes all Hosts, and their HostStatus and ServiceStatuses

Parameters:

hgName - The HostGroup to find

deep - Whether to perform a deep retrieval

Returns:

the HostGroup requested or null if it is not found

Throws:

CollageException