org.opennms.netmgt.config.dao.outages.api

Interface ReadablePollOutagesDao

All Superinterfaces:

ReadableDao<Outages>

All Known Subinterfaces:

OverrideablePollOutagesDao, WriteablePollOutagesDao

All Known Implementing Classes:

AbstractPollOutagesDao, OnmsPollOutagesDao, OverrideablePollOutagesDaoImpl, SentinelPollOutagesDao

public interface ReadablePollOutagesDao
extends ReadableDao<Outages>

Method Summary

Modifier and Type	Method and Description
Calendar	getEndOfOutage(Outage out) Return a calendar representing the end time of this outage, assuming it's currently active (i.e.
Calendar	getEndOfOutage(String outName) getEndOfOutage
List<Interface>	getInterfaces(String name) Return the interfaces for specified outage.
List<Node>	getNodeIds(String name) getNodeIds
List<Time>	getOutageTimes(String name) Return the outage times for specified outage.
String	getOutageType(String name) Return the type for specified outage.
boolean	isCurTimeInOutage(Outage out) Return if current time is part of specified outage.
boolean	isCurTimeInOutage(String outName) Return if current time is part of specified outage.
boolean	isInterfaceInOutage(String linterface, Outage out) Return if interfaces is part of specified outage.
boolean	isInterfaceInOutage(String linterface, String outName) Return if interfaces is part of specified outage.
boolean	isNodeIdInOutage(long lnodeid, Outage out) Return if nodeid is part of specified outage
boolean	isNodeIdInOutage(long lnodeid, String outName) Return if the node represented by the nodeid is part of specified outage.
boolean	isTimeInOutage(Calendar cal, Outage outage) Return if time is part of specified outage.
boolean	isTimeInOutage(Calendar cal, String outName) Return if time is part of specified outage.
boolean	isTimeInOutage(long time, String outName) Return if time is part of specified outage.

Methods inherited from interface org.opennms.netmgt.config.dao.common.api.ReadableDao

getReadOnlyConfig, reload

Method Detail

isNodeIdInOutage

boolean isNodeIdInOutage(long lnodeid,
                         String outName)

Return if the node represented by the nodeid is part of specified outage.

Parameters:

lnodeid - the nodeid to be checked

outName - the outage name

Returns:

the node is part of the specified outage

isInterfaceInOutage

boolean isInterfaceInOutage(String linterface,
                            String outName)

Return if interfaces is part of specified outage.

Parameters:

linterface - the interface to be looked up

outName - the outage name

Returns:

the interface is part of the specified outage

isCurTimeInOutage

boolean isCurTimeInOutage(String outName)

Return if current time is part of specified outage.

Parameters:

outName - the outage name

Returns:

true if current time is in outage

isTimeInOutage

boolean isTimeInOutage(long time,
                       String outName)

Return if time is part of specified outage.

Parameters:

time - the time in millis to look up

outName - the outage name

Returns:

true if time is in outage

getOutageType

String getOutageType(String name)

Return the type for specified outage.

Parameters:

name - the outage that is to be looked up

Returns:

the type for the specified outage, null if not found

getOutageTimes

List<Time> getOutageTimes(String name)

Return the outage times for specified outage.

Parameters:

name - the outage that is to be looked up

Returns:

the outage times for the specified outage, null if not found

getInterfaces

List<Interface> getInterfaces(String name)

Return the interfaces for specified outage.

Parameters:

name - the outage that is to be looked up

Returns:

the interfaces for the specified outage, null if not found

isInterfaceInOutage

boolean isInterfaceInOutage(String linterface,
                            Outage out)

Return if interfaces is part of specified outage.

Parameters:

linterface - the interface to be looked up

getOutageSchedule(out) - the outage

Returns:

the interface is part of the specified outage

isTimeInOutage

boolean isTimeInOutage(Calendar cal,
                       String outName)

Return if time is part of specified outage.

isTimeInOutage

boolean isTimeInOutage(Calendar cal,
                       Outage outage)

Return if time is part of specified outage.

Parameters:

cal - the calendar to lookup

getOutageSchedule(outage) - the outage

Returns:

true if time is in outage

isCurTimeInOutage

boolean isCurTimeInOutage(Outage out)

Return if current time is part of specified outage.

Parameters:

getOutageSchedule(out) - the outage

Returns:

true if current time is in outage

getNodeIds

List<Node> getNodeIds(String name)

getNodeIds

Parameters:

name - a String object.

Returns:

an array of Node objects.

getEndOfOutage

Calendar getEndOfOutage(String outName)

getEndOfOutage

Parameters:

outName - a String object.

Returns:

a Calendar object.

getEndOfOutage

Calendar getEndOfOutage(Outage out)

Return a calendar representing the end time of this outage, assuming it's currently active (i.e. right now is within one of the time periods) FIXME: This code is almost identical to isTimeInOutage... We need to fix it

Parameters:

getOutageSchedule(out) - a Outage object.

Returns:

a Calendar object.

isNodeIdInOutage

boolean isNodeIdInOutage(long lnodeid,
                         Outage out)

Return if nodeid is part of specified outage

Parameters:

lnodeid - the nodeid to be looked up

getOutageSchedule(out) - a Outage object.

Returns:

the node iis part of the specified outage