org.opennms.web.svclayer

Interface SiteStatusViewService

All Known Implementing Classes:

DefaultSiteStatusViewService

@Transactional(readOnly=true)
public interface SiteStatusViewService

Service layer API for the use cases that require the monitoed status of OpenNMS entities (i.e. OnmsNode) to be aggregated with status information that provides color and numberic indicators of status.

Since:

1.8.1

Version:

$Id: $

Author:

David Hustace, DJ Gregor, David Hustace, DJ Gregor

Method Summary

Methods

Modifier and Type	Method and Description
Collection<AggregateStatus>	createAggregateStatuses(AggregateStatusView statusView) createAggregateStatuses
Collection<AggregateStatus>	createAggregateStatuses(AggregateStatusView statusView, String statusSite) createAggregateStatuses
Collection<AggregateStatus>	createAggregateStatusesUsingNodeId(int nodeId, String viewName) createAggregateStatusesUsingNodeId
AggregateStatusView	createAggregateStatusView(String statusViewName) This method returns method returns a collection of aggregated status of nodes for each device category.
AggregateStatus	getAggregateStatus(String statusViewName, String statusSite, String rowLabel) getAggregateStatus
Collection<OnmsNode>	getNodes(String statusViewName, String statusSite, String rowLabel) getNodes

Method Detail

createAggregateStatusView

AggregateStatusView createAggregateStatusView(String statusViewName)

This method returns method returns a collection of aggregated status of nodes for each device category. In this case a column in the assets table is used as "site" for which to select devices. The devices are aggregated by the list of categories specified in categoryGrouping.

Parameters:

statusViewName - a String object.

Returns:

a AggregateStatusView object.

createAggregateStatuses

Collection<AggregateStatus> createAggregateStatuses(AggregateStatusView statusView)

createAggregateStatuses

Parameters:

statusView - a AggregateStatusView object.

Returns:

a Collection object.

createAggregateStatuses

Collection<AggregateStatus> createAggregateStatuses(AggregateStatusView statusView,
                                                  String statusSite)

createAggregateStatuses

Parameters:

statusView - a AggregateStatusView object.

statusSite - a String object.

Returns:

a Collection object.

createAggregateStatusesUsingNodeId

Collection<AggregateStatus> createAggregateStatusesUsingNodeId(int nodeId,
                                                             String viewName)

createAggregateStatusesUsingNodeId

Parameters:

nodeId - a int.

viewName - a String object.

Returns:

a Collection object.

getAggregateStatus

AggregateStatus getAggregateStatus(String statusViewName,
                                 String statusSite,
                                 String rowLabel)

getAggregateStatus

Parameters:

statusViewName - a String object.

statusSite - a String object.

rowLabel - a String object.

Returns:

a AggregateStatus object.

getNodes

Collection<OnmsNode> getNodes(String statusViewName,
                            String statusSite,
                            String rowLabel)

getNodes

Parameters:

statusViewName - a String object.

statusSite - a String object.

rowLabel - a String object.

Returns:

a Collection object.