com.adobe.cq.social.calendar.client.api

Class DateRangeFilter.UpperBoundedValue

java.lang.Object

com.adobe.cq.social.calendar.client.api.DateRangeFilter.UpperBoundedValue

Enclosing interface:

DateRangeFilter

public static class DateRangeFilter.UpperBoundedValue
extends Object

Represent the upper bound specification

Field Summary

Fields

Modifier and Type	Field and Description
static DateRangeFilter.UpperBoundedValue	ONE_MONTH_OFFSET

Constructor Summary

Constructors

Constructor and Description
UpperBoundedValue(String value)

Method Summary

Modifier and Type	Method and Description
int	daysBetween(Calendar c1, Calendar c2)
Calendar	getCalendar(Calendar start) Get the value of this instance.
int	getOffset() Get the original offset if the DateRangeFilter is not of type DateRangeType.RANGE
Calendar	getOffset(Calendar start, int offset) Get the offset Calendar from the specified start date and offset.
DateRangeFilter.DateRangeType	getType() Get the type of this instance
String	value() Get the value of this instance.

Methods inherited from class java.lang.Object

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

Field Detail

ONE_MONTH_OFFSET

public static DateRangeFilter.UpperBoundedValue ONE_MONTH_OFFSET

Constructor Detail

UpperBoundedValue

public UpperBoundedValue(String value)
                  throws InvalidDateException

Throws:

InvalidDateException

Method Detail

getType

public DateRangeFilter.DateRangeType getType()

Get the type of this instance

Returns:

the DateRangeType

value

public String value()

Get the value of this instance.

Returns:

this instance value

getOffset

public int getOffset()

Get the original offset if the DateRangeFilter is not of type DateRangeType.RANGE

getCalendar

public Calendar getCalendar(Calendar start)

Get the value of this instance. If this is a RANGE type, the method returns the client specification value, otherwise, it computes the value base on the client offset specification.

Parameters:

start - the start date

Returns:

getOffset

public Calendar getOffset(Calendar start,
                          int offset)

Get the offset Calendar from the specified start date and offset.

Parameters:

start - the calendar which we apply the offset to

offset - the offset, which can be positive or negative integer.

Returns:

the offset Calendar.

daysBetween

public int daysBetween(Calendar c1,
                       Calendar c2)