org.kuali.student.enrollment.acal.infc
Interface KeyDate

All Superinterfaces:

Entity, HasAttributes, HasAttributesAndMeta, HasId, HasMeta, HasPrimaryKey, HasState, HasType, IdEntity, TypeStateEntity

All Known Implementing Classes:

KeyDateInfo

public interface KeyDate
extends IdEntity

Information about a key date. A key date may represent a single point in time or a range depending on the value of isDateRange().

Since:

Tue Apr 05 14:22:34 EDT 2011

Author:

tom

Method Summary

Date	getEndDate() The end date and time of the key date.
Boolean	getIsAllDay() Tests if this key date is an all day event.
Boolean	getIsDateRange() Tests if this key date has a date range.
Boolean	getIsRelativeToKeyDate() Tests if this KeyDate is relative to another KeyDate.
String	getRelativeAnchorKeyDateId() Gets the anchor KeyDate to which this KeyDate is relative.
Date	getStartDate() The start date and time of the key date.

Methods inherited from interface org.kuali.student.r2.common.infc.HasId

getId

Methods inherited from interface org.kuali.student.r2.common.infc.Entity

getDescr, getName

Methods inherited from interface org.kuali.student.r2.common.infc.HasType

getType, getTypeKey

Methods inherited from interface org.kuali.student.r2.common.infc.HasState

getState, getStateKey

Methods inherited from interface org.kuali.student.r2.common.infc.HasAttributes

getAttributes

Methods inherited from interface org.kuali.student.r2.common.infc.HasMeta

getMeta

Method Detail

getIsAllDay

Boolean getIsAllDay()

Tests if this key date is an all day event. An all-day event does not have a meaningful time component in the date.

getIsRelativeToKeyDate

Boolean getIsRelativeToKeyDate()

Tests if this KeyDate is relative to another KeyDate.

getRelativeAnchorKeyDateId

String getRelativeAnchorKeyDateId()

Gets the anchor KeyDate to which this KeyDate is relative.

getIsDateRange

Boolean getIsDateRange()

Tests if this key date has a date range.

Returns:

true if the end date is different than the start date, false if the start end end date are the same

getStartDate

Date getStartDate()

The start date and time of the key date.

getEndDate

Date getEndDate()

The end date and time of the key date. The end date must be equal to or greater that the start.