com.nitido.nimx.nuggets.wcap
Class UserPref

java.lang.Object
  com.nitido.nimx.nuggets.wcap.UserPref

public class UserPref
extends java.lang.Object

The UserPref object encapsulate the information for the user preferences on iPlanet Calendar Server.

All the fields in this object can be null. If you are fetching the preference from the server, a field with null value means the user has not set anything for the specified field. If you are making changes to the preference, a null field is used to tell the server not to make any changes to the specified field.

The JavaDoc description of the default constructor contains more information of the fields.

Field Summary

static java.lang.String	CAL_DAYVIEW Constant for the default calendar view option "dayview".
static java.lang.String	CAL_MONTHVIEW Constant for the default calendar view option "monthview".
static java.lang.String	CAL_OVERVIEW Constant for the default calendar view option "overview".
static java.lang.String	CAL_WEEKVIEW Constant for the default calendar view option "weekview".

Constructor Summary

UserPref()
Default constructor.

UserPref(java.lang.String commonName, java.lang.String givenName, java.lang.String surname, java.lang.String preferredLanguage, java.lang.String defaultCalId, java.lang.String timezone, java.lang.Integer weekStart, java.lang.Character dateSeparator, java.lang.Boolean is24Hour, java.lang.String dateOrder, java.lang.Integer dayStart, java.lang.Integer dayEnd, java.lang.String slotInterval, java.lang.Boolean notifyEnabled, java.lang.String notifyEmail, java.lang.String defaultAlarmStart, java.lang.String defaultAlarmEmail, java.lang.String defaultView)
Constructor with initializing fields.

Method Summary

java.lang.String	getCommonName() Get Common Name.
java.lang.String	getDateOrder() Get date order.
java.lang.Character	getDateSeparator() Get Date Separator.
java.lang.Integer	getDayEnd() Get day end.
java.lang.Integer	getDayStart() Get day start.
java.lang.String	getDefaultAlarmEmail() Get default alarm email.
java.lang.String	getDefaultAlarmStart() Get default alarm start.
java.lang.String	getDefaultCalendarId() Get Default Calendar Id.
java.lang.String	getDefaultView() Get default calendar view.
java.lang.String	getGivenName() Get Given Name.
java.lang.Boolean	getIs24Hour() Get is24Hour.
java.lang.String	getNotifyEmail() Get notify email.
java.lang.Boolean	getNotifyEnabled() Get notify enabled.
java.lang.String	getPreferredLanguage() Get Preferred Language.
java.lang.String	getSlotInterval() Get slot interval.
java.lang.String	getSurname() Get Surname.
java.lang.String	getTimezone() Get Timezone.
java.lang.Integer	getWeekStart() Get Week Start.
void	setCommonName(java.lang.String commonName) Set Common Name.
void	setDateOrder(java.lang.String dateOrder) Set date order.
void	setDateSeparator(java.lang.Character dateSeparator) Set Date Separator.
void	setDayEnd(java.lang.Integer dayEnd) Set day end.
void	setDayStart(java.lang.Integer dayStart) Set day start.
void	setDefaultAlarmEmail(java.lang.String defaultAlarmEmail) Set default alarm email.
void	setDefaultAlarmStart(java.lang.String defaultAlarmStart) Set default alarm start.
void	setDefaultCalendarId(java.lang.String defaultCalId) Set Default Calendar Id.
void	setDefaultView(java.lang.String defaultView) Set default calendar view.
void	setGivenName(java.lang.String givenName) Set Given Name.
void	setIs24Hour(java.lang.Boolean is24Hour) Set is24Hour.
void	setNotifyEmail(java.lang.String notifyEmail) Set notify email.
void	setNotifyEnabled(java.lang.Boolean notifyEnabled) Set notify enabled.
void	setPreferredLanguage(java.lang.String preferredLanguage) Set Preferred Language.
void	setSlotInterval(java.lang.String slotInterval) Set slot interval.
void	setSurname(java.lang.String surname) Set Surname.
void	setTimezone(java.lang.String timezone) Set Timezone.
void	setWeekStart(java.lang.Integer weekStart) Set Week Start Day.
java.lang.String	toWcapQuery(WcapNugget nugget) Convert the information into a string that is used for constructing a WCAP query.

Methods inherited from class java.lang.Object

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

Field Detail

CAL_OVERVIEW

public static java.lang.String CAL_OVERVIEW

Constant for the default calendar view option "overview".

CAL_DAYVIEW

public static java.lang.String CAL_DAYVIEW

Constant for the default calendar view option "dayview".

CAL_WEEKVIEW

public static java.lang.String CAL_WEEKVIEW

Constant for the default calendar view option "weekview".

CAL_MONTHVIEW

public static java.lang.String CAL_MONTHVIEW

Constant for the default calendar view option "monthview".

Constructor Detail

UserPref

public UserPref()

Default constructor. This will initialize all the fields to null;

UserPref

public UserPref(java.lang.String commonName,
                java.lang.String givenName,
                java.lang.String surname,
                java.lang.String preferredLanguage,
                java.lang.String defaultCalId,
                java.lang.String timezone,
                java.lang.Integer weekStart,
                java.lang.Character dateSeparator,
                java.lang.Boolean is24Hour,
                java.lang.String dateOrder,
                java.lang.Integer dayStart,
                java.lang.Integer dayEnd,
                java.lang.String slotInterval,
                java.lang.Boolean notifyEnabled,
                java.lang.String notifyEmail,
                java.lang.String defaultAlarmStart,
                java.lang.String defaultAlarmEmail,
                java.lang.String defaultView)

Constructor with initializing fields.

Parameters:

commonName - A string of common name. The server default is set it to "givenName surname".

givenName - User's given name.

surname - User's surname.

preferredLanguage - A string of the 2 character language code. The server default is "en".

defaultCalId - The default calendar Id.

timezone - User's default timezone in the iCS supported format of "Continent/City" (America/New_York). This timezone is the "display" timezone, not the default timezone of the calendar. If you want to change the calendar's default timezone, you should use CalendarProperty instead. The iCS does not set any user timezone by default.

weekStart - An Integer object of 1-7, where 1 indicates the week starts on Sunday, and 7 indicates the week starts on Saturday.

dateSeparator - A character that is used as the separator for a date display's "year", "month" and "day".

is24Hour - True if the user wants the hour to be displayed in 0-23 hour. If this parameter is false, the display will format it into 1-12 hour with am/pm indicator.

dateOrder - The order of the "year", "month" and "day" to be displayed. e.g. "Y/M/D", "M/D/Y", "D/M/Y".

dayStart - The integer of the start hour of the day. (Note: No matter what you set for is24Hour, this field must be specified within the range of 0 to 23.)

dayEnd - The integer of the ending hour of the day. (Note: No matter what you set for is24Hour, this field must be specified within the range of 0 to 23.)

slotInterval - An ISO 8601 time duration format string to indicate the size of each time slot. For example, if you want to set it to half hour time slot, the string would be PT0H30M.

notifyEnabled - A boolean flag to indicate whether the notification for "event being scheduled" is enabled.

notifyEmail - A string of the email address to be notified. If more than one email address specified them in a single string, with "," between the email addresses.

defaultAlarmStart - An ISO 8601 time duration format string to indicate when the alarm start by default. For example, if you want the default alarm set off 15 min before an event/todo, the string would be "P15M". Please note that although the reminder is set to be before the actual event/todo, the defaultAlarmStart string should still be a positive string. Don't start it with "-".

If you want to disable the default reminder, you simply set this preference with an empty string "";

defaultAlarmEmail - A string of the email address to be notified. If more than one email address specified them in a single string, with "," between the email addresses.

defaultView - A string of the default view name.

Method Detail

toWcapQuery

public java.lang.String toWcapQuery(WcapNugget nugget)
                             throws WcapException

Convert the information into a string that is used for constructing a WCAP query. This method is designed for internal use by the WcapNugget only. It will return a String that is ready to be incorporated into a WCAP query. the return string is an URLEncoded string of the user preference.

Throws:

WcapException

setCommonName

public void setCommonName(java.lang.String commonName)

Set Common Name.

Parameters:

commonName - A string of common name. The server default is set it to "givenName surname".

getCommonName

public java.lang.String getCommonName()

Get Common Name.

setGivenName

public void setGivenName(java.lang.String givenName)

Set Given Name.

Parameters:

givenName - User's given name.

getGivenName

public java.lang.String getGivenName()

Get Given Name.

setSurname

public void setSurname(java.lang.String surname)

Set Surname.

Parameters:

surname - User's surname.

getSurname

public java.lang.String getSurname()

Get Surname.

setPreferredLanguage

public void setPreferredLanguage(java.lang.String preferredLanguage)

Set Preferred Language.

Parameters:

preferredLanguage - A string of the 2 character language code. The server default is "en".

getPreferredLanguage

public java.lang.String getPreferredLanguage()

Get Preferred Language.

setDefaultCalendarId

public void setDefaultCalendarId(java.lang.String defaultCalId)

Set Default Calendar Id.

Parameters:

defaultCalId - The default calendar Id.

getDefaultCalendarId

public java.lang.String getDefaultCalendarId()

Get Default Calendar Id.

setTimezone

public void setTimezone(java.lang.String timezone)

Set Timezone.

Parameters:

timezone - User's default timezone in the iCS supported format of "Continent/City" (America/New_York). This timezone is the "display" timezone, not the default timezone of the calendar. If you want to change the calendar's default timezone, you should use CalendarProperty instead. The iCS does not set any user timezone by default.

getTimezone

public java.lang.String getTimezone()

Get Timezone.

setWeekStart

public void setWeekStart(java.lang.Integer weekStart)

Set Week Start Day.

Parameters:

weekStart - An Integer object of 1-7, where 1 indicates the week starts on Sunday, and 7 indicates the week starts on Saturday.

getWeekStart

public java.lang.Integer getWeekStart()

Get Week Start.

setDateSeparator

public void setDateSeparator(java.lang.Character dateSeparator)

Set Date Separator.

Parameters:

dateSeparator - A character that is used as the separator for a date display's "year", "month" and "day".

getDateSeparator

public java.lang.Character getDateSeparator()

Get Date Separator.

setIs24Hour

public void setIs24Hour(java.lang.Boolean is24Hour)

Set is24Hour.

Parameters:

is24Hour - True if the user wants the hour to be displayed in 0-23 hour. If this parameter is false, the display will format it into 1-12 hour with am/pm indicator.

getIs24Hour

public java.lang.Boolean getIs24Hour()

Get is24Hour.

setDateOrder

public void setDateOrder(java.lang.String dateOrder)

Set date order.

Parameters:

dateOrder - The order of the "year", "month" and "day" to be displayed. e.g. "Y/M/D", "M/D/Y", "D/M/Y".

getDateOrder

public java.lang.String getDateOrder()

Get date order.

setDayStart

public void setDayStart(java.lang.Integer dayStart)

Set day start.

Parameters:

dayStart - The integer of the start hour of the day. (Note: No matter what you set for is24Hour, this field must be specified within the range of 0 to 23.)

getDayStart

public java.lang.Integer getDayStart()

Get day start.

setDayEnd

public void setDayEnd(java.lang.Integer dayEnd)

Set day end.

Parameters:

dayEnd - The integer of the ending hour of the day. (Note: No matter what you set for is24Hour, this field must be specified within the range of 0 to 23.)

getDayEnd

public java.lang.Integer getDayEnd()

Get day end.

setSlotInterval

public void setSlotInterval(java.lang.String slotInterval)

Set slot interval.

Parameters:

slotInterval - An ISO 8601 time duration format string to indicate the size of each time slot. For example, if you want to set it to half hour time slot, the string would be PT0H30M.

getSlotInterval

public java.lang.String getSlotInterval()

Get slot interval.

setNotifyEnabled

public void setNotifyEnabled(java.lang.Boolean notifyEnabled)

Set notify enabled.

Parameters:

notifyEnabled - A boolean flag to indicate whether the notification for "event being scheduled" is enabled.

getNotifyEnabled

public java.lang.Boolean getNotifyEnabled()

Get notify enabled.

setNotifyEmail

public void setNotifyEmail(java.lang.String notifyEmail)

Set notify email.

Parameters:

notifyEmail - A string of the email address to be notified. If more than one email address specified them in a single string, with "," between the email addresses.

getNotifyEmail

public java.lang.String getNotifyEmail()

Get notify email.

setDefaultAlarmStart

public void setDefaultAlarmStart(java.lang.String defaultAlarmStart)

Set default alarm start.

Parameters:

defaultAlarmStart - An ISO 8601 time duration format string to indicate when the alarm start by default. For example, if you want the default alarm set off 15 min before an event/todo, the string would be "P15M". Please note that although the reminder is set to be before the actual event/todo, the defaultAlarmStart string should still be a positive string. Don't start it with "-".

If you want to disable the default reminder, you simply set this preference with an empty string "";

getDefaultAlarmStart

public java.lang.String getDefaultAlarmStart()

Get default alarm start.

setDefaultAlarmEmail

public void setDefaultAlarmEmail(java.lang.String defaultAlarmEmail)

Set default alarm email.

Parameters:

defaultAlarmEmail - A string of the email address to be notified. If more than one email address specified them in a single string, with "," between the email addresses.

getDefaultView

public java.lang.String getDefaultView()

Get default calendar view.

setDefaultView

public void setDefaultView(java.lang.String defaultView)

Set default calendar view.

Parameters:

defaultView - A string of the default view name.

getDefaultAlarmEmail

public java.lang.String getDefaultAlarmEmail()

Get default alarm email.