com.openexchange.api
Class OXTask

java.lang.Object
  extended by com.openexchange.api.OXObject
      extended by com.openexchange.api.OXSqlObject
          extended by com.openexchange.api.OXCommon
              extended by com.openexchange.api.OXCalendar
                  extended by com.openexchange.api.OXTask
All Implemented Interfaces:
java.lang.Cloneable

public class OXTask
extends OXCalendar

OXTask

Author:
Sebastian Kauss

Nested Class Summary
 class OXTask.SearchQuery
           
 
Field Summary
static java.lang.String ACTUAL_COSTS
           
static java.lang.String ACTUAL_DURATION
           
static java.lang.String AFTER_COMPLETE
           
static java.lang.String BILLING_INFORMATION
           
static java.lang.String COMPANIES
           
static java.lang.String CURRENCY
           
static java.lang.String DATE_COMPLETED
           
static int DEFAULTFOLDER
           
static int DEFERRED
           
static int DONE
           
static java.lang.String DURATION_TYPE
           
static int HIGH
           
static int IN_PROGRESS
           
static int LOW
           
static int NORMAL
           
static int NOT_STARTED
           
static java.lang.String PERCENT_COMPLETE
           
static java.lang.String PRIORITY
           
static java.lang.String PROJECT_ID
           
static java.lang.String STATUS
           
static java.lang.String TARGET_COSTS
           
static java.lang.String TARGET_DURATION
           
static java.lang.String TRIP_METER
           
static java.lang.String TYPE_OF_COSTS
           
static int WAITUNG
           
 
Fields inherited from class com.openexchange.api.OXCalendar
ACCEPT, ALARM, APRIL, AUGUST, DAILY, DAY, DAY_IN_MONTH, DAYS, DECEMBER, DECLINE, END_DATE, FEBRUARY, FRIDAY, INTERVAL, JANUARY, JULY, JUNE, MARCH, MAY, MONDAY, MONTH, MONTHLY, NONE, NOTE, NOTIFICATION, NOVEMBER, OCTOBER, PARTICIPANTS, PRIVATE, RECURRENCE_DATE_POSITION, RECURRENCE_ID, RECURRENCE_POSITION, RECURRENCE_TYPE, SATURDAY, SEPTEMBER, START_DATE, SUNDAY, THURSDAY, TITLE, TUESDAY, UNTIL, WEDNESDAY, WEEK_DAY, WEEKEND_DAY, WEEKLY, YEARLY
 
Fields inherited from class com.openexchange.api.OXCommon
ATTACHMENT_FLAG, CATEGORIES, CREATED_BY, FOLDER_ID, MODIFIED_BY, PERSONAL_FOLDER_ID
 
Fields inherited from class com.openexchange.api.OXSqlObject
DELETED, NEW_AND_MODIFIED
 
Fields inherited from class com.openexchange.api.OXObject
CREATION_TIME, LAST_MODIFIED, OBJECT_ID
 
Method Summary
 java.lang.Object clone()
           
 OXObject create(java.lang.Object internalobject)
          returns a new instance of the OXObject
static OXTask createOXTask(java.lang.Object internalobject)
          creates a new Instance of OXTask
 void createQuery(OXTask.SearchQuery oxsearch)
          creates a extended Query with the given SearchQuery
 void delete()
          delete this task
 float getActualCosts()
          return actual costs
 float getActualDuration()
          return actual duration
 java.lang.String getBillingInformation()
          return billing information
 java.lang.String getCompanies()
          return companies
 java.lang.String getCurrency()
          return currency
 java.util.Date getDateCompleted()
          return date_completed
 int getDoublicateID()
          return the id of the object with the same attributes.
 java.lang.String getDurationType()
          return duration type
 int getPercentComplete()
          return percent complete
 int getPriority()
          return priority
 OXSearchQuery getSearchQuery()
          return OXSearchQuery
 int getStatus()
          return status
 float getTargetCosts()
          return target_costs
 float getTargetDuration()
          return target duration
 java.lang.String getTripMeter()
          return trip meter
 void load()
          load the object with all informations
 void reset()
          reset the object to the default values
 void save()
          save the task
 void saveConfirm(int confirm)
          saves the confirmation to this appointment for the current user
 void saveConfirm(java.lang.String confirm_user, int confirm)
          saves the confirmation to this appointment for a specified user
 void setActualCosts(float actual_costs)
          set actual_costs
 void setActualDuration(float actual_duration)
          set actual duration
 void setBillingInformation(java.lang.String billing_information)
          set billing information
 void setCompanies(java.lang.String companies)
          set companies
 void setCurrency(java.lang.String currency)
          set currency
 void setDeleteQuery(java.util.Date since)
          creates a Query to get private deleted objects since
 void setDeleteQuery(java.util.Date since, int folder_id)
          creates a Query to get all deleted objects since in folder
 void setDurationType(java.lang.String duration_type)
          set duration type
 void setPercentComplete(int percent_complete)
          set percent complete
 void setPriority(int priority)
          set priority
 void setSimpleQuery(java.util.Date since)
          creates a Query to get all private objects since the given date
 void setSimpleQuery(java.util.Date since, int folder_id)
          creates a Query to get all objects in the specified folder
 void setStatus(int status)
          set status
 void setTargetCosts(float target_costs)
          set target costs
 void setTargetDuration(float target_duration)
          set target duration
 void setTripMeter(java.lang.String trip_meter)
          set trip meter
 
Methods inherited from class com.openexchange.api.OXCalendar
addParticipantGroup, addParticipantUser, addParticipantUser, getAlarm, getEnd, getInterval, getNote, getParticipantConfirm, getParticipantGroups, getParticipantUsers, getRecurrenceDayInMonth, getRecurrenceDays, getRecurrenceID, getRecurrenceMonth, getRecurrencePosition, getRecurrenceType, getStart, getTitle, getUntil, isPrivate, removeParticipantGroup, removeParticipantUser, setAlarm, setDailyRecurrence, setDailyRecurrence, setEnd, setInterval, setMonthlyRecurrence, setMonthlyRecurrence, setMonthlyRecurrence, setMonthlyRecurrence, setNote, setNotification, setRecurrenceDay, setRecurrenceMonth, setRecurrenceMonthDay, setRecurrenceType, setStart, setTitle, setUntil, setWeeklyRecurrence, setWeeklyRecurrence, setYearlyRecurrence, setYearlyRecurrence, setYearlyRecurrence, setYearlyRecurrence
 
Methods inherited from class com.openexchange.api.OXCommon
delete, delete, getCreatedBy, getFolderID, getModifiedBy, hasAttachments, load, setFolderID, setReturnnames
 
Methods inherited from class com.openexchange.api.OXSqlObject
canDelete, canRead, canWrite, destroy, getNext, getSQL_ORDER, getSQL_SELECT, getSQL_WHERE, getSQL, insert, load, setSQL_ORDER, setSQL_WHERE, setSQL
 
Methods inherited from class com.openexchange.api.OXObject
contains, get, getConnection, getCreationTime, getInternalFieldname, getLastModified, getMandatoryFields, getMappedField, getObjectID, getPassword, getReadableFields, getUser, getWriteableFields, isNull, iterator, put, remove, set, setInternalObject, setObjectID, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

PROJECT_ID

public static final java.lang.String PROJECT_ID
See Also:
Constant Field Values

TARGET_COSTS

public static final java.lang.String TARGET_COSTS
See Also:
Constant Field Values

ACTUAL_COSTS

public static final java.lang.String ACTUAL_COSTS
See Also:
Constant Field Values

TARGET_DURATION

public static final java.lang.String TARGET_DURATION
See Also:
Constant Field Values

ACTUAL_DURATION

public static final java.lang.String ACTUAL_DURATION
See Also:
Constant Field Values

PRIORITY

public static final java.lang.String PRIORITY
See Also:
Constant Field Values

PERCENT_COMPLETE

public static final java.lang.String PERCENT_COMPLETE
See Also:
Constant Field Values

DURATION_TYPE

public static final java.lang.String DURATION_TYPE
See Also:
Constant Field Values

TYPE_OF_COSTS

public static final java.lang.String TYPE_OF_COSTS
See Also:
Constant Field Values

CURRENCY

public static final java.lang.String CURRENCY
See Also:
Constant Field Values

STATUS

public static final java.lang.String STATUS
See Also:
Constant Field Values

TRIP_METER

public static final java.lang.String TRIP_METER
See Also:
Constant Field Values

BILLING_INFORMATION

public static final java.lang.String BILLING_INFORMATION
See Also:
Constant Field Values

COMPANIES

public static final java.lang.String COMPANIES
See Also:
Constant Field Values

AFTER_COMPLETE

public static final java.lang.String AFTER_COMPLETE
See Also:
Constant Field Values

DATE_COMPLETED

public static final java.lang.String DATE_COMPLETED
See Also:
Constant Field Values

DEFAULTFOLDER

public static final int DEFAULTFOLDER
See Also:
Constant Field Values

LOW

public static final int LOW
See Also:
Constant Field Values

NORMAL

public static final int NORMAL
See Also:
Constant Field Values

HIGH

public static final int HIGH
See Also:
Constant Field Values

NOT_STARTED

public static final int NOT_STARTED
See Also:
Constant Field Values

IN_PROGRESS

public static final int IN_PROGRESS
See Also:
Constant Field Values

DONE

public static final int DONE
See Also:
Constant Field Values

WAITUNG

public static final int WAITUNG
See Also:
Constant Field Values

DEFERRED

public static final int DEFERRED
See Also:
Constant Field Values
Method Detail

create

public OXObject create(java.lang.Object internalobject)
Description copied from class: OXObject
returns a new instance of the OXObject


createOXTask

public static OXTask createOXTask(java.lang.Object internalobject)
                           throws OXPermissionException
creates a new Instance of OXTask

Parameters:
internalobject -
Returns:
oxtask
Throws:
OXPermissionException

setDeleteQuery

public void setDeleteQuery(java.util.Date since)
                    throws java.lang.Exception,
                           OXPermissionException
creates a Query to get private deleted objects since

Specified by:
setDeleteQuery in class OXCommon
Parameters:
since -
Throws:
java.lang.Exception
OXPermissionException

setDeleteQuery

public void setDeleteQuery(java.util.Date since,
                           int folder_id)
                    throws java.lang.Exception,
                           OXPermissionException
creates a Query to get all deleted objects since in folder

Parameters:
since -
Throws:
java.lang.Exception
OXPermissionException

setSimpleQuery

public void setSimpleQuery(java.util.Date since)
                    throws java.lang.Exception,
                           OXConflictException,
                           OXPermissionException
creates a Query to get all private objects since the given date

Specified by:
setSimpleQuery in class OXCommon
Parameters:
since -
Throws:
java.lang.Exception
OXConflictException
OXPermissionException

setSimpleQuery

public void setSimpleQuery(java.util.Date since,
                           int folder_id)
                    throws java.lang.Exception,
                           OXPermissionException,
                           OXConflictException
creates a Query to get all objects in the specified folder

Specified by:
setSimpleQuery in class OXCommon
Parameters:
since -
folder_id -
Throws:
java.lang.Exception
OXPermissionException
OXConflictException

createQuery

public void createQuery(OXTask.SearchQuery oxsearch)
                 throws java.lang.Exception,
                        OXConflictException
creates a extended Query with the given SearchQuery

Parameters:
oxsearch -
Throws:
java.lang.Exception
OXConflictException

load

public void load()
          throws java.lang.Exception,
                 OXConflictException,
                 OXPermissionException
load the object with all informations

Specified by:
load in class OXSqlObject
Throws:
java.lang.Exception
OXConflictException
OXPermissionException

getDateCompleted

public java.util.Date getDateCompleted()
return date_completed

Returns:
date_completed

getStatus

public int getStatus()
return status

Returns:
status

getPriority

public int getPriority()
return priority

Returns:
priority

getPercentComplete

public int getPercentComplete()
return percent complete

Returns:
percent_complete

getActualCosts

public float getActualCosts()
return actual costs

Returns:
actual_costs

getTargetCosts

public float getTargetCosts()
return target_costs

Returns:
target_costs

getActualDuration

public float getActualDuration()
return actual duration

Returns:
actual_duration

getTargetDuration

public float getTargetDuration()
return target duration

Returns:
target_duration

getTripMeter

public java.lang.String getTripMeter()
return trip meter

Returns:
trip_meter

getCurrency

public java.lang.String getCurrency()
return currency

Returns:
currency

getDurationType

public java.lang.String getDurationType()
return duration type

Returns:
duration_type

getBillingInformation

public java.lang.String getBillingInformation()
return billing information

Returns:
billing_information

getCompanies

public java.lang.String getCompanies()
return companies

Returns:
companies

getSearchQuery

public OXSearchQuery getSearchQuery()
return OXSearchQuery

Specified by:
getSearchQuery in class OXSqlObject
Returns:
oxsearchquery

setStatus

public void setStatus(int status)
set status

Parameters:
status -

setPriority

public void setPriority(int priority)
set priority

Parameters:
priority -

setPercentComplete

public void setPercentComplete(int percent_complete)
set percent complete

Parameters:
percent_complete -

setActualCosts

public void setActualCosts(float actual_costs)
set actual_costs

Parameters:
actual_costs -

setTargetCosts

public void setTargetCosts(float target_costs)
set target costs

Parameters:
target_costs -

setActualDuration

public void setActualDuration(float actual_duration)
set actual duration

Parameters:
actual_duration -

setTargetDuration

public void setTargetDuration(float target_duration)
set target duration

Parameters:
target_duration -

setTripMeter

public void setTripMeter(java.lang.String trip_meter)
set trip meter

Parameters:
trip_meter -

setCurrency

public void setCurrency(java.lang.String currency)
set currency

Parameters:
currency -

setDurationType

public void setDurationType(java.lang.String duration_type)
set duration type

Parameters:
duration_type -

setBillingInformation

public void setBillingInformation(java.lang.String billing_information)
set billing information

Parameters:
billing_information -

setCompanies

public void setCompanies(java.lang.String companies)
set companies

Parameters:
companies -

save

public void save()
          throws java.lang.Exception,
                 OXConflictException,
                 OXPermissionException,
                 OXMandatoryFieldException
save the task

Specified by:
save in class OXSqlObject
Throws:
java.lang.Exception
OXConflictException
OXPermissionException
OXMandatoryFieldException

delete

public void delete()
            throws java.lang.Exception,
                   OXConflictException,
                   OXPermissionException
delete this task

Specified by:
delete in class OXObject
Throws:
java.lang.Exception
OXConflictException
OXPermissionException

saveConfirm

public void saveConfirm(int confirm)
                 throws java.lang.Exception,
                        OXConflictException,
                        OXPermissionException
saves the confirmation to this appointment for the current user

Parameters:
confirm - (NONE, ACCEPT, DECLINE)
Throws:
java.lang.Exception
OXConflictException
OXPermissionException

saveConfirm

public void saveConfirm(java.lang.String confirm_user,
                        int confirm)
                 throws java.lang.Exception,
                        OXConflictException,
                        OXPermissionException
saves the confirmation to this appointment for a specified user

Parameters:
confirm_user -
confirm - (NONE, ACCEPT, DECLINE)
Throws:
java.lang.Exception
OXConflictException
OXPermissionException

reset

public void reset()
reset the object to the default values

Overrides:
reset in class OXSqlObject

clone

public java.lang.Object clone()
Overrides:
clone in class OXCalendar

getDoublicateID

public int getDoublicateID()
return the id of the object with the same attributes. Returns -1 if no equal object found.

Specified by:
getDoublicateID in class OXCommon