com.openexchange.api
Class OXCommon

java.lang.Object
  extended bycom.openexchange.api.OXObject
      extended bycom.openexchange.api.OXSqlObject
          extended bycom.openexchange.api.OXCommon
All Implemented Interfaces:
java.lang.Cloneable
Direct Known Subclasses:
OXCalendar, OXContact

public abstract class OXCommon
extends OXSqlObject

OXCommon

Author:
Sebastian Kauss

Field Summary
static java.lang.String ATTACHMENT_FLAG
           
static java.lang.String CATEGORIES
           
static java.lang.String CREATED_BY
           
static java.lang.String FOLDER_ID
           
static java.lang.String MODIFIED_BY
           
static java.lang.String 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
 
Constructor Summary
OXCommon()
           
 
Method Summary
 java.lang.Object clone()
           
 void delete(int object_id)
          delete the object with the given object_id
 void delete(int object_id, int folder_id)
          delete the object with the given object_id and folder_id
 java.lang.String getCreatedBy()
          return the creator uid
abstract  int getDoublicateID()
           
 int getFolderID()
          return folder_id
 java.lang.String getModifiedBy()
          return uid of the last modification
 boolean hasAttachments()
          return true if attachments are attached to this contact otherwise false
 void load(int object_id, int folder_id)
          load the object with the given object_id and folder_id
abstract  void setDeleteQuery(java.util.Date since)
           
 void setFolderID(int folder_id)
          set the folder id
 void setReturnnames(java.lang.String[] returnnames)
          set which fields will be returned in the query
abstract  void setSimpleQuery(java.util.Date since)
           
abstract  void setSimpleQuery(java.util.Date since, int folder_id)
           
 
Methods inherited from class com.openexchange.api.OXSqlObject
canDelete, canRead, canWrite, destroy, getNext, getSearchQuery, getSQL_ORDER, getSQL_SELECT, getSQL_WHERE, getSQL, insert, load, load, reset, save, setSQL_ORDER, setSQL_WHERE, setSQL
 
Methods inherited from class com.openexchange.api.OXObject
contains, delete, 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

FOLDER_ID

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

PERSONAL_FOLDER_ID

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

CREATED_BY

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

MODIFIED_BY

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

ATTACHMENT_FLAG

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

CATEGORIES

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

OXCommon

public OXCommon()
Method Detail

load

public void load(int object_id,
                 int folder_id)
          throws java.lang.Exception,
                 OXConflictException,
                 OXPermissionException
load the object with the given object_id and folder_id

Parameters:
object_id -
folder_id -
Throws:
java.lang.Exception
OXConflictException
OXPermissionException

delete

public void delete(int object_id)
            throws java.lang.Exception,
                   OXConflictException,
                   OXPermissionException
delete the object with the given object_id

Parameters:
object_id -
Throws:
java.lang.Exception
OXConflictException
OXPermissionException

delete

public void delete(int object_id,
                   int folder_id)
            throws java.lang.Exception,
                   OXConflictException,
                   OXPermissionException
delete the object with the given object_id and folder_id

Parameters:
object_id -
folder_id -
Throws:
java.lang.Exception
OXConflictException
OXPermissionException

setReturnnames

public void setReturnnames(java.lang.String[] returnnames)
set which fields will be returned in the query

Parameters:
returnnames -

getCreatedBy

public java.lang.String getCreatedBy()
return the creator uid

Returns:
uid

getModifiedBy

public java.lang.String getModifiedBy()
return uid of the last modification

Returns:
uid

getFolderID

public int getFolderID()
return folder_id

Returns:
folder_id

setFolderID

public void setFolderID(int folder_id)
set the folder id


hasAttachments

public boolean hasAttachments()
return true if attachments are attached to this contact otherwise false

Returns:
has_attachments

clone

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

setDeleteQuery

public abstract void setDeleteQuery(java.util.Date since)
                             throws java.lang.Exception,
                                    OXConflictException,
                                    OXPermissionException
Throws:
java.lang.Exception
OXConflictException
OXPermissionException

setSimpleQuery

public abstract void setSimpleQuery(java.util.Date since)
                             throws java.lang.Exception,
                                    OXConflictException,
                                    OXPermissionException
Throws:
java.lang.Exception
OXConflictException
OXPermissionException

setSimpleQuery

public abstract void setSimpleQuery(java.util.Date since,
                                    int folder_id)
                             throws java.lang.Exception,
                                    OXConflictException,
                                    OXPermissionException
Throws:
java.lang.Exception
OXConflictException
OXPermissionException

getDoublicateID

public abstract int getDoublicateID()