Package org.opennms.web.svclayer.model

Class RelativeTimePeriod

java.lang.Object

org.opennms.web.svclayer.model.RelativeTimePeriod

public class RelativeTimePeriod
extends Object

RelativeTimePeriod class.

Since:

1.8.1

Version:

$Id: $

Author:

ranger

Field Summary

Fields

Modifier and Type	Field	Description
static RelativeTimePeriod	DEFAULT_RELATIVE_TIME_PERIOD

Constructor Summary

Constructors

Constructor	Description
RelativeTimePeriod()	Constructor for RelativeTimePeriod.
RelativeTimePeriod(String id, String name, int offsetField, int offsetAmount)	Constructor for RelativeTimePeriod.

Method Summary

Modifier and Type	Method	Description
static RelativeTimePeriod[]	getDefaultPeriods()	getDefaultPeriods
String	getId()	getId
String	getName()	getName
int	getOffsetAmount()	getOffsetAmount
int	getOffsetField()	getOffsetField
static RelativeTimePeriod	getPeriodByIdOrDefault(String id)	getPeriodByIdOrDefault
static RelativeTimePeriod	getPeriodByIdOrDefault(RelativeTimePeriod[] periods, String id, RelativeTimePeriod defaultPeriod)	getPeriodByIdOrDefault
long[]	getStartAndEndTimes()	getStartAndEndTimes
void	setId(String id)	setId
void	setName(String name)	setName
void	setOffsetAmount(int offsetAmount)	setOffsetAmount
void	setOffsetField(int offsetField)	setOffsetField

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_RELATIVE_TIME_PERIOD

public static final RelativeTimePeriod DEFAULT_RELATIVE_TIME_PERIOD

Constructor Detail

RelativeTimePeriod

public RelativeTimePeriod()

Constructor for RelativeTimePeriod.

RelativeTimePeriod

public RelativeTimePeriod(String id,
                          String name,
                          int offsetField,
                          int offsetAmount)

Constructor for RelativeTimePeriod.

Parameters:

id - a String object.

name - a String object.

offsetField - a int.

offsetAmount - a int.

Method Detail

getId

public String getId()

getId

Returns:

a String object.

setId

public void setId(String id)

setId

Parameters:

id - a String object.

getName

public String getName()

getName

Returns:

a String object.

setName

public void setName(String name)

setName

Parameters:

name - a String object.

getOffsetField

public int getOffsetField()

getOffsetField

Returns:

a int.

setOffsetField

public void setOffsetField(int offsetField)

setOffsetField

Parameters:

offsetField - a int.

getOffsetAmount

public int getOffsetAmount()

getOffsetAmount

Returns:

a int.

setOffsetAmount

public void setOffsetAmount(int offsetAmount)

setOffsetAmount

Parameters:

offsetAmount - a int.

getDefaultPeriods

public static RelativeTimePeriod[] getDefaultPeriods()

getDefaultPeriods

Returns:

an array of RelativeTimePeriod objects.

getPeriodByIdOrDefault

public static RelativeTimePeriod getPeriodByIdOrDefault(String id)

getPeriodByIdOrDefault

Parameters:

id - a String object.

Returns:

a RelativeTimePeriod object.

getPeriodByIdOrDefault

public static RelativeTimePeriod getPeriodByIdOrDefault(RelativeTimePeriod[] periods,
                                                        String id,
                                                        RelativeTimePeriod defaultPeriod)

getPeriodByIdOrDefault

Parameters:

periods - an array of RelativeTimePeriod objects.

id - a String object.

defaultPeriod - a RelativeTimePeriod object.

Returns:

a RelativeTimePeriod object.

getStartAndEndTimes

public long[] getStartAndEndTimes()

getStartAndEndTimes

Returns:

an array of long.