|
Compoze Software, Inc. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.compoze.calendar.Appointment
This class represents an appointment.
To add and search for appointments, see the Appointments
collection
class. Once the appointment is obtained, its
accessor methods may be called to
set and get properties. The update()
method
must be called to store any changes to the server.
An Appointment conforms to the vCalendar specification (RFC #2445). To
generate a vCalendar compliant representation of an
appointment, user toVcalendarString()
.
The following table contains the mappings from Appointment properties
to their corresponding Java methods:
Field Summary | |
static java.lang.String |
DEFAULT_VCALENDAR_VERSION
The default vCalendar version. |
Constructor Summary | |
Appointment()
Constructor. |
Method Summary | |
void |
addCategory(Category category)
Adds the specified category to the list of categories. |
void |
clearDateRecurrence()
Clears the date recurrence for the appointment. |
MeetingRequest |
createMeetingRequest()
Creates a meeting request for this appointment. |
void |
delete()
Deletes the appointment. |
void |
delete(int iInstance)
Deletes the appointment. |
AccessManager |
getAccessManager()
Gets the access manager for this appointment. |
java.lang.String |
getBillingInformation()
Gets the billing information of the appointment. |
BusyStatus |
getBusyStatus()
Gets the busy status of the appointment. |
Categories |
getCategories()
Gets the list of categories. |
java.lang.String |
getComments()
Gets the comments for the appointment. |
long |
getCustomNum1()
Gets the custom number1 field of the appointment. |
long |
getCustomNum2()
Gets the custom number2 field of the appointment. |
long |
getCustomNum3()
Gets the custom number3 field of the appointment. |
long |
getCustomNum4()
Gets the custom number4 field of the appointment. |
java.lang.String |
getCustomStr1()
Gets the custom string1 field of the appointment. |
java.lang.String |
getCustomStr2()
Gets the custom string2 field of the appointment. |
java.lang.String |
getCustomStr3()
Gets the custom string3 field of the appointment. |
java.lang.String |
getCustomStr4()
Gets the custom string4 field of the appointment. |
java.util.Date |
getDateCreated()
Gets the date the appointment was created. |
java.util.Date |
getDateLastModified()
Gets the date the appointment was last modified. |
DateRange |
getDateRange()
Gets the date range of the appointment. |
DateRecurrence |
getDateRecurrence()
Gets the date recurrence for the appointment. |
java.lang.String |
getDescription()
Gets the description of the appointment. |
java.util.Date |
getEndDate()
Gets the end date of the appointment. |
long |
getID()
Gets the unique identifier (id) of the appointment. |
java.lang.String |
getLocation()
Gets the location of the appointment. |
java.lang.String |
getMileage()
Gets the mileage of the appointment. |
java.lang.String |
getOrganizer()
Gets the name of the organizer. |
Priority |
getPriority()
Gets the priority of the appointment. |
java.util.Date |
getStartDate()
Gets the start date of the appointment. |
java.lang.String |
getSummary()
Gets the summary of the appointment. |
java.lang.String |
getSummary(int iLength)
Gets the summary of the appointment. |
boolean |
isAllDayEvent()
Checks whether or not this event is an all day event. |
boolean |
isRecurring()
Checks if this appointment is a recurring appointment (its date recurrence is not null ). |
void |
removeCategories()
Removes all categories from the list of categories. |
void |
removeCategory(Category category)
Removes the specified category from the list of categories. |
void |
setAllDayEvent(boolean bAllDayEvent)
Sets whether or not this event is an all day event. |
void |
setBillingInformation(java.lang.String sBillingInformation)
Sets the billing information of the appointment. |
void |
setBusyStatus(BusyStatus busyStatus)
Sets the busy status of the appointment. |
void |
setComments(java.lang.String sComments)
Sets the comments for the appointment. |
void |
setCustomNum1(long lCustomNum1)
Sets the custom number1 field of the appointment. |
void |
setCustomNum2(long lCustomNum2)
Sets the custom number2 field of the appointment. |
void |
setCustomNum3(long lCustomNum3)
Sets the custom number3 field of the appointment. |
void |
setCustomNum4(long lCustomNum4)
Sets the custom number4 field of the appointment. |
void |
setCustomStr1(java.lang.String sCustomStr1)
Sets the custom string1 field of the appointment. |
void |
setCustomStr2(java.lang.String sCustomStr2)
Sets the custom string2 field of the appointment. |
void |
setCustomStr3(java.lang.String sCustomStr3)
Sets the custom string3 field of the appointment. |
void |
setCustomStr4(java.lang.String sCustomStr4)
Sets the custom string4 field of the appointment. |
void |
setDateRecurrence(DateRecurrence recurrence)
Sets the date recurrence that defines a recurring appointment. |
void |
setDates(java.util.Date startDate,
java.util.Date endDate)
Sets the start and end dates of the appointment. |
void |
setDescription(java.lang.String sDescription)
Sets the description of the appointment. |
void |
setLocation(java.lang.String sLocation)
Sets the location of the appointment. |
void |
setMileage(java.lang.String sMileage)
Sets the mileage of the appointment. |
void |
setPriority(Priority priority)
Sets the priority of the appointment. |
void |
setSummary(java.lang.String sSummary)
Sets the summary of the appointment. |
java.lang.String |
toString()
Returns a string representation of the object. |
java.lang.String |
toVcalendarString()
Creates a string that contains the vCalendar compliant (RFC #2445) representation of the appointment. |
java.lang.String |
toVcalendarString(java.lang.String sVersion,
boolean bOffice98Compatible)
Creates a string that contains the vCalendar compliant (RFC #2445) representation of the appointment. |
boolean |
update()
Updates the appointment (saves the appointment entry). |
boolean |
update(boolean bForce)
Updates the appointment (saves the appointment entry). |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final java.lang.String DEFAULT_VCALENDAR_VERSION
toVcalendarString()
Constructor Detail |
public Appointment()
Appointments.add()
to
create an appointment.Method Detail |
public long getID()
public MeetingRequest createMeetingRequest()
public void setDateRecurrence(DateRecurrence recurrence)
To clear the date recurrence, use clearDateRecurrence()
.
recurrence
- the date recurrence (may not be null
)public DateRecurrence getDateRecurrence()
isRecurring()
method.null
if it is not setpublic void clearDateRecurrence()
public boolean isRecurring()
null
).true
if this appointment is a recurring appointment; false
otherwisepublic boolean isAllDayEvent()
true
if the event is an all day event; false
if it is not an all day eventpublic void setAllDayEvent(boolean bAllDayEvent)
bAllDayEvent
- if true
, the event is an all day eventpublic Categories getCategories()
addCategory(Category)
and removeCategory(Category)
.null
if no categories are setCategory
,
addCategory(Category)
,
removeCategory(Category)
public void addCategory(Category category)
category
- the category to add (may not be null
)getCategories()
,
removeCategory(Category)
public void removeCategories()
getCategories()
,
addCategory(Category)
,
removeCategory(Category)
public void removeCategory(Category category)
category
- the category to remove (may not be null
)getCategories()
,
addCategory(Category)
public java.lang.String getBillingInformation()
null
if no billing information is setpublic void setBillingInformation(java.lang.String sBillingInformation)
sBillingInformation
- the billing information of the appointment or null
if no billing information is setpublic java.lang.String getComments()
null
if no comments are setpublic void setComments(java.lang.String sComments)
sComments
- the comments for the appointment or null
if no comments are setpublic java.lang.String getLocation()
null
if no location is setpublic void setLocation(java.lang.String sLocation)
sLocation
- the location of the appointment or null
if no location is setpublic java.lang.String getSummary()
If the summary is an empty string, the setting appointment.summary
from
calendar_resources.properties
is returned. This will prevent an
empty string from being returned. If you wish to return the empty string,
set appointment.summary
to blank.
null
if no summary is setpublic java.lang.String getSummary(int iLength)
iLength
- the maximum length of the result (string plus "...")public void setSummary(java.lang.String sSummary)
sSummary
- the summary of the appointment or null
if no summary is setpublic java.lang.String getDescription()
null
if no description is setpublic void setDescription(java.lang.String sDescription)
sDescription
- the description of the appointment or null
if no description is setpublic java.lang.String getMileage()
null
if no mileage is setpublic void setMileage(java.lang.String sMileage)
sMileage
- the mileage of the appointment or null
if no mileage is setpublic long getCustomNum1()
null
if the custom number1 field is not setpublic void setCustomNum1(long lCustomNum1)
lCustomNum1
- the custom number1 field of the appointmentpublic long getCustomNum2()
null
if the custom number2 field is not setpublic void setCustomNum2(long lCustomNum2)
lCustomNum2
- the custom number2 field of the appointmentpublic long getCustomNum3()
null
if the custom number3 field is not setpublic void setCustomNum3(long lCustomNum3)
lCustomNum3
- the custom number3 field of the appointmentpublic long getCustomNum4()
null
if the custom number4 field is not setpublic void setCustomNum4(long lCustomNum4)
lCustomNum4
- the custom number4 field of the appointmentpublic java.lang.String getCustomStr1()
null
if the custom string1 field is not setpublic void setCustomStr1(java.lang.String sCustomStr1)
sCustomStr1
- the custom string1 field of the appointmentpublic java.lang.String getCustomStr2()
null
if the custom string2 field is not setpublic void setCustomStr2(java.lang.String sCustomStr2)
sCustomStr2
- the custom string2 field of the appointmentpublic java.lang.String getCustomStr3()
null
if the custom string3 field is not setpublic void setCustomStr3(java.lang.String sCustomStr3)
sCustomStr3
- the custom string3 field of the appointmentpublic java.lang.String getCustomStr4()
null
if the custom string4 field is not setpublic void setCustomStr4(java.lang.String sCustomStr4)
sCustomStr4
- the custom string4 field of the appointmentpublic void setPriority(Priority priority)
priority
- the priority of the appointment (may not be null
)public Priority getPriority()
null
if not setpublic void setBusyStatus(BusyStatus busyStatus)
busyStatus
- the busy status of the appointment (may not be null
)public BusyStatus getBusyStatus()
null
if not setpublic java.util.Date getStartDate()
public java.util.Date getEndDate()
public DateRange getDateRange()
public void setDates(java.util.Date startDate, java.util.Date endDate)
startDate
- the start date of the appointmentendDate
- the end date of the appointmentpublic java.lang.String getOrganizer()
public java.util.Date getDateCreated()
public java.util.Date getDateLastModified()
public boolean update() throws java.security.AccessControlException
true
if the update is successful; false
otherwisejava.security.AccessControlException
- occurs if the user does not have permission to edit the appointmentpublic boolean update(boolean bForce) throws java.security.AccessControlException
bForce
- true
to force the update; false
otherwise (currently ignored)true
if the update is successful; false
otherwisejava.security.AccessControlException
- occurs if the user does not have permission to edit the appointmentpublic void delete() throws java.security.AccessControlException
java.security.AccessControlException
- occurs if the user does not have permission to delete the appointmentdelete(int)
,
DateRecurrence.RULE_THIS_INSTANCE
public void delete(int iInstance) throws java.security.AccessControlException
iInstance
- the delete rule (see DateRecurrence.RULE_
constants)java.security.AccessControlException
- occurs if the user does not have permission to delete the appointmentpublic AccessManager getAccessManager() throws AccessManagerException
AccessManagerException
- an error occurs retrieving the access managerCalendarPermission
public java.lang.String toVcalendarString()
DEFAULT_VCALENDAR_VERSION
public java.lang.String toVcalendarString(java.lang.String sVersion, boolean bOffice98Compatible)
sVersion
- the vCalendar version to presentbOffice98Compatible
- true
if the vCalendar should support Office 98public java.lang.String toString()
toString
in class java.lang.Object
|
Compoze Software, Inc. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |