|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.openexchange.api.OXObject
com.openexchange.api.OXSqlObject
com.openexchange.api.OXFolder
OXFolder
Nested Class Summary | |
class |
OXFolder.Permission
|
Field Summary | |
static int |
CALENDAR
|
static int |
CONTACT
|
static java.lang.String |
CREATED_BY
|
static java.lang.String |
CREATOR
|
static java.lang.String |
DEFAULTFOLDER
|
static java.lang.String |
FOLDER_ID
|
static int |
GLOBALADDRESSBOOK
|
static int |
INTERNALUSERS
|
static java.lang.String |
LAST_MODIFIED
|
static java.lang.String |
MODIFIED_BY
|
static java.lang.String |
MODULE
|
static java.lang.String |
OWNER
|
static java.lang.String |
PERMISSIONS
|
static int |
PRIVATE
|
static int |
PUBLIC
|
static int |
SHARED
|
static int |
TASK
|
static java.lang.String |
TITLE
|
static java.lang.String |
TYPE
|
static int |
UNBOUND
|
Fields inherited from class com.openexchange.api.OXSqlObject |
DELETED, NEW_AND_MODIFIED |
Fields inherited from class com.openexchange.api.OXObject |
CREATION_TIME, OBJECT_ID |
Method Summary | |
boolean |
canDelete()
is the folder "deleteable" |
boolean |
canRead()
is the folder readable |
boolean |
canWrite()
is the folder writeable |
java.lang.Object |
clone()
|
OXObject |
create(java.lang.Object internalobject)
|
static OXFolder |
createOXFolder(java.lang.Object internalobject)
creates a new Instance of OXFolder |
void |
delete()
delete the folder |
int |
getFolderID()
return the folder id |
int |
getModule()
return the module |
OXFolder.Permission |
getPermission()
return the Permission Object |
OXSearchQuery |
getSearchQuery()
return the OXSearchQuery |
java.lang.String |
getTitle()
return the title |
int |
getType()
return the type |
boolean |
isDefaultFolder()
return true if this folder is an default folder or else otherwise |
void |
load()
load the folder |
void |
reset()
reset the object to the default values |
void |
save()
save the folder |
void |
setDeleteQuery(java.util.Date since)
creates a Query to get all deleted folders since the given date |
void |
setFolderID(int folder_id)
set the folder id |
void |
setModule(int module)
set the module |
void |
setPermission(OXFolder.Permission permission)
set the permission |
void |
setSimpleQuery(java.util.Date since,
int type)
creates a Query to get all folders since the given date and the given type |
void |
setTitle(java.lang.String title)
set the title |
void |
setType(int type)
set the type |
Methods inherited from class com.openexchange.api.OXSqlObject |
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 |
public static final java.lang.String CREATED_BY
public static final java.lang.String LAST_MODIFIED
public static final java.lang.String MODIFIED_BY
public static final java.lang.String OWNER
public static final java.lang.String CREATOR
public static final java.lang.String FOLDER_ID
public static final java.lang.String MODULE
public static final java.lang.String TYPE
public static final java.lang.String TITLE
public static final java.lang.String DEFAULTFOLDER
public static final java.lang.String PERMISSIONS
public static final int PRIVATE
public static final int PUBLIC
public static final int SHARED
public static final int GLOBALADDRESSBOOK
public static final int INTERNALUSERS
public static final int TASK
public static final int CALENDAR
public static final int CONTACT
public static final int UNBOUND
Method Detail |
public OXObject create(java.lang.Object internalobject)
public static OXFolder createOXFolder(java.lang.Object internalobject)
internalobject
-
public void setDeleteQuery(java.util.Date since) throws java.lang.Exception, OXConflictException, OXPermissionException
since
-
java.lang.Exception
OXConflictException
OXPermissionException
public void setSimpleQuery(java.util.Date since, int type) throws java.lang.Exception, OXConflictException, OXPermissionException
since
- type
-
java.lang.Exception
OXConflictException
OXPermissionException
public void load() throws java.lang.Exception, OXConflictException, OXPermissionException
load
in class OXSqlObject
java.lang.Exception
OXConflictException
OXPermissionException
public boolean canRead() throws java.lang.Exception
canRead
in class OXSqlObject
java.lang.Exception
public boolean canWrite() throws java.lang.Exception
canWrite
in class OXSqlObject
java.lang.Exception
public boolean canDelete()
canDelete
in class OXSqlObject
public boolean isDefaultFolder()
public int getFolderID()
public int getModule()
public int getType()
public java.lang.String getTitle()
public OXFolder.Permission getPermission()
public OXSearchQuery getSearchQuery()
getSearchQuery
in class OXSqlObject
public void setFolderID(int folder_id)
folder_id
- public void setModule(int module)
module
- public void setType(int type)
type
- public void setTitle(java.lang.String title)
title
- public void setPermission(OXFolder.Permission permission)
permission
- public void save() throws java.lang.Exception, OXConflictException, OXMandatoryFieldException, OXPermissionException
save
in class OXSqlObject
java.lang.Exception
OXConflictException
OXMandatoryFieldException
OXPermissionException
public void delete() throws java.lang.Exception, OXConflictException, OXPermissionException
delete
in class OXObject
java.lang.Exception
OXConflictException
OXPermissionException
public void reset()
reset
in class OXSqlObject
public java.lang.Object clone()
clone
in class OXSqlObject
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |