com.funambol.common.pim.model.calendar
Class Task

java.lang.Object
  extended by com.funambol.common.pim.model.calendar.CalendarContent
      extended by com.funambol.common.pim.model.calendar.Task

public class Task
extends CalendarContent

An object representing a task (todo) contained in a calendar item, with all the information supported by Funambol it contains. This is the "foundational model" of a task, used to exchange information about such items between server and connectors. It can also be used by clients. This object provide normalization of the following properties: - status - complete - percent complete if one or more of these propeties state that the task is completed, the other properties will be filled with proper values. That is, if one of the properties listed above says that the task is completed both the left properties will say the same: status = 4 => complete = true, percent complete = 100 complete = true=> status = 4 , percent complete = 100 percent complete = 100 => complete = true, status = 4 On the other side, if none of these properties say that the task is completed, the date completed property is returned as empty, without considering any values set before: status != 4, percent complete != 100, complete = false => date complete = null

Version:
$Id: Task.java,v 1.4 2008-04-17 17:03:00 mauro Exp $

Field Summary
static java.lang.String HUNDRED_PERCENT
           
 
Fields inherited from class com.funambol.common.pim.model.calendar.CalendarContent
accessClass, allDay, attendees, busyStatus, categories, contact, created, dalarm, description, dtEnd, dtStamp, dtStart, duration, folder, lastModified, latitude, location, longitude, meetingStatus, mileage, organizer, palarm, priority, recurrencePattern, reminder, sequence, status, summary, uid, url, xTags
 
Constructor Summary
Task()
          Creates en empty task.
 
Method Summary
 Property getActualWork()
          Returns the time spent so far for the completion of the task.
 Property getBillingInformation()
          Returns information for the task's billing.
 Property getComplete()
          Returns whether the task has been completed or not.
 PropertyWithTimeZone getDateCompleted()
          Returns the date/time when the task has been completed.
 PropertyWithTimeZone getDueDate()
          Returns the due date.
 Property getImportance()
          Returns the task's importance.
 Property getOwner()
          Returns the owner of the task.
 Property getPercentComplete()
          Returns the task's completion percentage.
 Property getSensitivity()
          Returns the task's sensitivity.
 Property getStatus()
          Returns the status of the task item.
 Property getTeamTask()
          Returns whether this is a team task or an individual one.
 Property getTotalWork()
          Returns the total time that should be spent for the completion of the task.
 Property isTeamTask()
          Deprecated. Since version 7.1.0, getTeamTask should be used instead, because methods starting with "is" usually return booleans.
 void setActualWork(Property actualWork)
          Setter for property actualWork.
 void setBillingInformation(Property billingInformation)
          Setter for property billingInformation.
 void setComplete(Property complete)
          Setter for property complete.
 void setDateCompleted(Property dateCompleted)
          Setter for property dateCompleted on the basis of a Property (without time zone).
 void setDateCompleted(PropertyWithTimeZone dateCompleted)
          Setter for property dateCompleted.
 void setDueDate(Property dueDate)
          Setter for the due date on the basis of a Property (without time zone).
 void setDueDate(PropertyWithTimeZone dueDate)
          Setter for the due date.
 void setImportance(Property importance)
          Setter for the importance.
 void setOwner(Property owner)
          Setter for property owner.
 void setPercentComplete(Property percentComplete)
          Setter for property percentComplete.
 void setSensitivity(Property sensitivity)
          Setter for the sensitivity.
 void setTeamTask(Property teamTask)
          Setter for property teamTask.
 void setTotalWork(Property totalWork)
          Setter for property totalWork.
 
Methods inherited from class com.funambol.common.pim.model.calendar.CalendarContent
addAttendee, addXTag, extractInterval, getAccessClass, getAllDay, getAttendees, getBusyStatus, getCategories, getContact, getCreated, getDAlarm, getDescription, getDtEnd, getDtStamp, getDtStart, getDuration, getFolder, getLastModified, getLatitude, getLocation, getLongitude, getMeetingStatus, getMileage, getOrganizer, getPAlarm, getPriority, getRecurrencePattern, getReminder, getSequence, getSummary, getUid, getUrl, getXTags, isAllDay, isRecurrent, removeRecurrence, resetAttendees, setAccessClass, setAllDay, setAllDay, setBusyStatus, setCategories, setContact, setCreated, setCreated, setDAlarm, setDAlarm, setDescription, setDtEnd, setDtEnd, setDtStamp, setDtStamp, setDtStart, setDtStart, setDuration, setFolder, setLastModified, setLastModified, setLatitude, setLocation, setLongitude, setMeetingStatus, setMileage, setOrganizer, setPAlarm, setPAlarm, setPriority, setRecurrencePattern, setReminder, setSequence, setStatus, setSummary, setUid, setUrl, setXTag
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

HUNDRED_PERCENT

public static final java.lang.String HUNDRED_PERCENT
See Also:
Constant Field Values
Constructor Detail

Task

public Task()
Creates en empty task.

Method Detail

getActualWork

public Property getActualWork()
Returns the time spent so far for the completion of the task.

Returns:
value of property actualWork

getBillingInformation

public Property getBillingInformation()
Returns information for the task's billing.

Returns:
value of property billingInformation

getDateCompleted

public PropertyWithTimeZone getDateCompleted()
Returns the date/time when the task has been completed.

Returns:
value of property dateCompleted

getOwner

public Property getOwner()
Returns the owner of the task.

Returns:
value of property owner

getPercentComplete

public Property getPercentComplete()
Returns the task's completion percentage.

Returns:
value of property percentComplete

isTeamTask

public Property isTeamTask()
Deprecated. Since version 7.1.0, getTeamTask should be used instead, because methods starting with "is" usually return booleans.

Returns whether this is a team task or an individual one.

Returns:
value of property teamTask

getTeamTask

public Property getTeamTask()
Returns whether this is a team task or an individual one.

Returns:
value of property teamTask

getTotalWork

public Property getTotalWork()
Returns the total time that should be spent for the completion of the task.

Returns:
value of property totalWork

getComplete

public Property getComplete()
Returns whether the task has been completed or not.

Returns:
value of property complete

setActualWork

public void setActualWork(Property actualWork)
Setter for property actualWork.

Parameters:
actualWork - new value of property actualWork

setBillingInformation

public void setBillingInformation(Property billingInformation)
Setter for property billingInformation.

Parameters:
billingInformation - new value of property billingInformation

setComplete

public void setComplete(Property complete)
Setter for property complete.

Parameters:
complete - new value of property complete

setDateCompleted

public void setDateCompleted(PropertyWithTimeZone dateCompleted)
Setter for property dateCompleted.

Parameters:
dateCompleted - new value of property dateCompleted

setDateCompleted

public void setDateCompleted(Property dateCompleted)
Setter for property dateCompleted on the basis of a Property (without time zone).

Parameters:
dateCompleted - new value of property dateCompleted as a Property (the time zone is set to null)

setOwner

public void setOwner(Property owner)
Setter for property owner.

Parameters:
owner - new value of property owner

setPercentComplete

public void setPercentComplete(Property percentComplete)
Setter for property percentComplete.

Parameters:
percentComplete - new value of property percentComplete

setTeamTask

public void setTeamTask(Property teamTask)
Setter for property teamTask.

Parameters:
teamTask - new value of property teamTask

setTotalWork

public void setTotalWork(Property totalWork)
Setter for property totalWork.

Parameters:
totalWork - new value of property totalWork

getDueDate

public PropertyWithTimeZone getDueDate()
Returns the due date. Property dueDate is treated as an alias for dtEnd.

Returns:
value of property dtEnd

setDueDate

public void setDueDate(PropertyWithTimeZone dueDate)
Setter for the due date. Property dueDate is treated as an alias for dtEnd.

Parameters:
dueDate - new value of property dtEnd

setDueDate

public void setDueDate(Property dueDate)
Setter for the due date on the basis of a Property (without time zone). Property dueDate is treated as an alias for dtEnd.

Parameters:
dueDate - new value of property dtEnd as a Property (the time zone is set to null)

getImportance

public Property getImportance()
Returns the task's importance. Property importance is treated as an alias for priority.

Returns:
value of property priority

setImportance

public void setImportance(Property importance)
Setter for the importance. Property importance is treated as an alias for priority.

Parameters:
importance - new value of property priority

getSensitivity

public Property getSensitivity()
Returns the task's sensitivity. Property sensitivity is treated as an alias for accessClass.

Returns:
value of property accessClass

setSensitivity

public void setSensitivity(Property sensitivity)
Setter for the sensitivity. Property sensitivity is treated as an alias for accessClass.

Parameters:
sensitivity - new value of property accessClass

getStatus

public Property getStatus()
Returns the status of the task item.

Overrides:
getStatus in class CalendarContent
Returns:
the status property


Copyright © 2001-2009 Funambol.