Overview

Package

Class

Tree

Serialized

Deprecated

Index

Help

PREV class NEXT class

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.lotus.cs
Class CalendarDayInfo

java.lang.Object
  com.lotus.cs.CalendarDayInfo

public class CalendarDayInfo

extends java.lang.Object

CalendarDayInfo encapsulates a day within a calendar's current time period. It provides accessor methods to the list of calendar entries for the day and facilities for dealing with timeslots.

To create a CalendarDayInfo object, use DominoService.getViewInfo() to first create a ViewInfo and then use ViewInfo.getCalendarDayInfo()

To get the list of entries in the day, use getEntryInfo.

See Also:

DominoService.getViewInfo(java.lang.String, java.lang.String), ViewInfo.getCalendarDayInfo(java.lang.String, int), EntryInfo

Method Summary
java.util.Calendar	getDate() Returns a Java Calendar object for the day.
EntryInfo[]	getEntryInfo() Returns the set of entries for the day.
java.lang.String	getISODate() Returns a String representation for the day's date.
java.lang.String	getNextISODate(int grid) Returns a String representation for the next day's date.
java.lang.String	getPreviousISODate(int grid) Returns a String representation for the previous day's date.
boolean	isInTodaysMonth() Returns whether or not the day is in the current month.
boolean	isToday() Returns whether or not the day is the current day.

Methods inherited from class java.lang.Object

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

Method Detail

getEntryInfo

public final EntryInfo[] getEntryInfo()

Returns the set of entries for the day.

See Also:

EntryInfo

getISODate

public final java.lang.String getISODate()

Returns a String representation for the day's date. ISO data format: "yyyy-MM-dd" in all locales.

getDate

public final java.util.Calendar getDate()

Returns a Java Calendar object for the day.

getPreviousISODate

public java.lang.String getPreviousISODate(int grid)

Returns a String representation for the previous day's date. ISO data format: "yyyy-MM-dd" in all locales. This is useful when implementing navigation controls for the calendar.

Parameters:

grid - calendar style, one of ViewInfo.ONE_DAY, ViewInfo.TWO_DAYS, ViewInfo.ONE_WEEK, ViewInfo.TWO_WEEKS, or ViewInfo.ONE_MONTH.

getNextISODate

public java.lang.String getNextISODate(int grid)

Returns a String representation for the next day's date. ISO data format: "yyyy-MM-dd" in all locales. This is useful when implementing navigation controls for the calendar.

Parameters:

grid - calendar style, one of ViewInfo.ONE_DAY, ViewInfo.TWO_DAYS, ViewInfo.ONE_WEEK, ViewInfo.TWO_WEEKS, or ViewInfo.ONE_MONTH.

isToday

public boolean isToday()

Returns whether or not the day is the current day.

isInTodaysMonth

public boolean isInTodaysMonth()

Returns whether or not the day is in the current month.