Package org.bedework.calfacade.base
Interface StartEndComponent
- All Known Subinterfaces:
EventEntity
- All Known Implementing Classes:
BwEvent,BwEventAnnotation,BwEventNewWrapper,BwEventObj,BwEventProxy
public interface StartEndComponent
This interface is implemented by entities which have a start and an end.
They may also have a duration, though it's meaning differs.
For event and todo entities we may have an end specified with a duration or with a date or date/time value, or o end date at all.
We always calculate an end date internally, so we do not need to use the duration until we render the object.
- Author:
- Mike Douglass douglm - bedework.edu
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final charEnd specified with a date(time)static final charDuration specifiedstatic final charNo end or duration -
Method Summary
Modifier and TypeMethodDescriptiongetDtend()Get the event's endGet the start time for the entityGet the duration for the entity if an event or todo, or the requested duration for a free/busy object.charget the endType flag for an event or todoA todo may have no start/end.voidsetDtend(BwDateTime val) Set the end or due date for the entityvoidsetDtstart(BwDateTime val) Set the start time for the entityvoidsetDuration(String val) Set the duration for the entity if an event or todo, or the requested duration for a free/busy object.voidsetEndType(char val) Set the endType flag for an event or todovoidsetNoStart(Boolean val) A todo may have no start/end.
-
Field Details
-
endTypeNone
static final char endTypeNoneNo end or duration- See Also:
-
endTypeDate
static final char endTypeDateEnd specified with a date(time)- See Also:
-
endTypeDuration
static final char endTypeDurationDuration specified- See Also:
-
-
Method Details
-
setDtstart
Set the start time for the entity- Parameters:
val- Event's start
-
getDtstart
BwDateTime getDtstart()Get the start time for the entity- Returns:
- The start
-
setDtend
Set the end or due date for the entity- Parameters:
val- end
-
getDtend
BwDateTime getDtend()Get the event's end- Returns:
- The event's end
-
setEndType
void setEndType(char val) Set the endType flag for an event or todo- Parameters:
val- char endType
-
getEndType
char getEndType()get the endType flag for an event or todo- Returns:
- char end Type
-
setDuration
Set the duration for the entity if an event or todo, or the requested duration for a free/busy object.- Parameters:
val- string duration
-
getDuration
String getDuration()Get the duration for the entity if an event or todo, or the requested duration for a free/busy object.- Returns:
- the event's duration
-
setNoStart
A todo may have no start/end. If so it always appears in the current day until completed.- Parameters:
val-
-
getNoStart
Boolean getNoStart()A todo may have no start/end. If so it always appears in the current day until completed.- Returns:
- true for no start/end
-