com.nitido.nimx.nuggets.wcap
Class CalendarProperty

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

public class CalendarProperty
extends java.lang.Object

The data object that encapsulate the property of a calendar.

This object will be returned by WcapNugget.searchForCalendars. A programmer may also use this to create a new calendar with WcapNugget.createCalendar() or set the properties of an existing calendar.

Constructor Summary

CalendarProperty(java.lang.String calId, java.util.Vector categories, java.lang.String charSet, java.lang.String description, java.lang.String language, java.lang.String masterEmail, java.lang.String name, java.util.Vector owners, java.lang.String tzid, java.util.Vector acl)
Default constructor.

Method Summary

boolean	equals(java.lang.Object inObj) Override the default java.lang.Object's equal command.
java.util.Vector	getACL() Get the access control list.
java.lang.String	getCalendarId() Get calendar id.
java.util.Vector	getCategories() Get categories.
java.lang.String	getCharacterSet() Get charater set.
java.lang.String	getDescription() Get description.
java.lang.String	getLanguage() Get language.
java.lang.String	getMasterEmail() Get email contact of the calendar.
java.lang.String	getName() Get the text name of the calendar (not the id).
java.util.Vector	getOwners() Get owners ids.
java.lang.String	getTimeZoneId() Get the calendar's default Time Zone id.
void	setACL(java.util.Vector acl) Set the access control list.
void	setCalendarId(java.lang.String calId) Set calendar id.
void	setCategories(java.util.Vector categories) Set categories.
void	setCharacterSet(java.lang.String charSet) Set character set.
void	setDescription(java.lang.String description) Set description.
void	setLanguage(java.lang.String language) Set language.
void	setMasterEmail(java.lang.String masterEmail) Set email contact of the calendar.
void	setName(java.lang.String name) Set the text name of the calendar (not the id).
void	setOwners(java.util.Vector owners) Set owners ids.
void	setTimeZoneId(java.lang.String tzid) Set the calendar's default Time Zone id.
java.lang.String	toWcapQuery(WcapNugget nugget) Convert the component into a string that is used for constructing a WCAP query.

Methods inherited from class java.lang.Object

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

Constructor Detail

CalendarProperty

public CalendarProperty(java.lang.String calId,
                        java.util.Vector categories,
                        java.lang.String charSet,
                        java.lang.String description,
                        java.lang.String language,
                        java.lang.String masterEmail,
                        java.lang.String name,
                        java.util.Vector owners,
                        java.lang.String tzid,
                        java.util.Vector acl)

Default constructor.

The calId field must be valid and non-null while other fields may take a null value. However, the meaning of the null value is different when the object is passed to WcapNugget.createCalendar() and WcapNugget.setCalendarProperty();

For creation, the iPlanet Calendar Server will assign its default values for those fields that are null. You can read more details about the ICS's default value from their programmer's guide.

If the object is used for modifying an existing calendar, a null value means the corresponding property field will remain unchanged.

Parameters:

calId - The identifying id of the calendar. This value must be valid and non-null for both creating and modifying a calendar.

categories - A Vector of String of the category names.

charSet - The character set used by the calendar.

description - The detail description of the calendar.

language - The preferred language.

masterEmail - The master's email address.

name - The display name of the calendar.

owners - A Vector of String that represents the owners' user id. Unlike the primary owner, an owner cannot modify the calendar property. An owner usually can only change the events and todos (unless the ACL of the calendar has been changed).

tzid - The default time zone id of the calendar.

acl - A Vector of AccessControlEntry objects which represent the rules of access control for the calendar.

Method Detail

getCalendarId

public java.lang.String getCalendarId()

Get calendar id.

setCalendarId

public void setCalendarId(java.lang.String calId)

Set calendar id.

getCategories

public java.util.Vector getCategories()

Get categories.

setCategories

public void setCategories(java.util.Vector categories)

Set categories.

getCharacterSet

public java.lang.String getCharacterSet()

Get charater set.

setCharacterSet

public void setCharacterSet(java.lang.String charSet)

Set character set.

getDescription

public java.lang.String getDescription()

Get description.

setDescription

public void setDescription(java.lang.String description)

Set description.

getLanguage

public java.lang.String getLanguage()

Get language.

setLanguage

public void setLanguage(java.lang.String language)

Set language.

getMasterEmail

public java.lang.String getMasterEmail()

Get email contact of the calendar.

setMasterEmail

public void setMasterEmail(java.lang.String masterEmail)

Set email contact of the calendar.

getName

public java.lang.String getName()

Get the text name of the calendar (not the id).

setName

public void setName(java.lang.String name)

Set the text name of the calendar (not the id).

getOwners

public java.util.Vector getOwners()

Get owners ids.

Returns:

a vector of owner id's String objects

setOwners

public void setOwners(java.util.Vector owners)

Set owners ids.

Parameters:

owners - a vector of owner id's String objects.

getTimeZoneId

public java.lang.String getTimeZoneId()

Get the calendar's default Time Zone id.

setTimeZoneId

public void setTimeZoneId(java.lang.String tzid)

Set the calendar's default Time Zone id.

getACL

public java.util.Vector getACL()

Get the access control list.

Returns:

a vector of AccessControlEntry objects

setACL

public void setACL(java.util.Vector acl)

Set the access control list.

Parameters:

acl - a vector of AccessControlEntry objects

toWcapQuery

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

Convert the component into a string that is used for constructing a WCAP query. This method is designed for internal use by the WcapNugget only.

Throws:

WcapException

equals

public boolean equals(java.lang.Object inObj)

Override the default java.lang.Object's equal command. This will compares the content of the fields. In case of a vector or array field, it will compare the content of the field.

Overrides:

equals in class java.lang.Object