public abstract class UserSettingMailStorage
extends java.lang.Object
implements com.openexchange.cache.registry.CacheAvailabilityListener
UserSettingMailStorage
- Access to UserSettingMail
Modifier and Type | Method and Description |
---|---|
abstract void |
clearStorage()
Clears this storage's cache if any used
|
void |
deleteUserSettingMail(int user,
com.openexchange.groupware.contexts.Context ctx)
Deletes the user's mail settings from database
|
abstract void |
deleteUserSettingMail(int user,
com.openexchange.groupware.contexts.Context ctx,
java.sql.Connection writeConArg)
Deletes the user's mail settings from database
|
static UserSettingMailStorage |
getInstance()
Gets the singleton instance of
UserSettingMailStorage |
UserSettingMail |
getUserSettingMail(int user,
com.openexchange.groupware.contexts.Context ctx)
A convenience method that returns
getUserSettingMail(int, Context, Connection) with the connection parameter set to
null . |
UserSettingMail |
getUserSettingMail(int user,
com.openexchange.groupware.contexts.Context ctx,
java.sql.Connection readCon)
A convenience method that returns
loadUserSettingMail(int, Context, Connection) . |
UserSettingMail |
getUserSettingMail(int user,
int cid)
A convenience method that returns
getUserSettingMail(int, Context, Connection) with the connection parameter set to
null . |
UserSettingMail |
getUserSettingMail(com.openexchange.session.Session session)
A convenience method that returns
getUserSettingMail(int, Context, Connection) with the connection parameter set to
null . |
UserSettingMail |
loadUserSettingMail(int user,
com.openexchange.groupware.contexts.Context ctx)
Loads user's mail settings from database
|
abstract UserSettingMail |
loadUserSettingMail(int user,
com.openexchange.groupware.contexts.Context ctx,
java.sql.Connection readConArg)
Loads user's mail settings from database
|
static void |
releaseInstance()
Releases this storage instance
|
abstract void |
removeUserSettingMail(int user,
com.openexchange.groupware.contexts.Context ctx)
Removes the user's mail settings from cache if any used
|
void |
saveUserSettingMail(UserSettingMail usm,
int user,
com.openexchange.groupware.contexts.Context ctx)
Saves given user's mail settings to database
|
abstract void |
saveUserSettingMail(UserSettingMail usm,
int user,
com.openexchange.groupware.contexts.Context ctx,
java.sql.Connection writeConArg)
Saves given user's mail settings to database
|
void |
saveUserSettingMailBits(UserSettingMail usm,
int user,
com.openexchange.groupware.contexts.Context ctx)
Saves given user's mail settings bits to database
|
abstract void |
saveUserSettingMailBits(UserSettingMail usm,
int user,
com.openexchange.groupware.contexts.Context ctx,
java.sql.Connection writeConArg)
Saves given user's mail settings bits to database
|
abstract void |
shutdownStorage()
Triggers necessary action to shutdown the storage
|
public static final UserSettingMailStorage getInstance()
UserSettingMailStorage
UserSettingMailStorage
public static final void releaseInstance()
public final UserSettingMail getUserSettingMail(com.openexchange.session.Session session) throws com.openexchange.exception.OXException
getUserSettingMail(int, Context, Connection)
with the connection parameter set to
null
.session
- The sessionUserSettingMail
which matches given user ID and context or null
on exceptioncom.openexchange.exception.OXException
- If context cannot be loadedpublic final UserSettingMail getUserSettingMail(int user, int cid) throws com.openexchange.exception.OXException
getUserSettingMail(int, Context, Connection)
with the connection parameter set to
null
.user
- The user IDcid
- The context IDUserSettingMail
which matches given user ID and context or null
on exceptioncom.openexchange.exception.OXException
- If context cannot be loadedpublic final UserSettingMail getUserSettingMail(int user, com.openexchange.groupware.contexts.Context ctx)
getUserSettingMail(int, Context, Connection)
with the connection parameter set to
null
.user
- The user IDctx
- The contextUserSettingMail
which matches given user ID and context or null
on exceptionpublic final UserSettingMail getUserSettingMail(int user, com.openexchange.groupware.contexts.Context ctx, java.sql.Connection readCon)
loadUserSettingMail(int, Context, Connection)
. If an exception is thrown in delegated
method null
is returned.user
- The user IDctx
- The contextreadCon
- The readable connection (may be null
)UserSettingMail
which matches given user ID and context or null
on exceptionpublic final void saveUserSettingMailBits(UserSettingMail usm, int user, com.openexchange.groupware.contexts.Context ctx) throws com.openexchange.exception.OXException
usm
- the user's mail settings to saveuser
- the user IDctx
- the contextcom.openexchange.exception.OXException
- if user's mail settings could not be savedpublic abstract void saveUserSettingMailBits(UserSettingMail usm, int user, com.openexchange.groupware.contexts.Context ctx, java.sql.Connection writeConArg) throws com.openexchange.exception.OXException
usm
- the user's mail settings to saveuser
- the user IDctx
- the contextwriteConArg
- - the writable connection; may be null
com.openexchange.exception.OXException
- if user's mail settings could not be savedpublic final void saveUserSettingMail(UserSettingMail usm, int user, com.openexchange.groupware.contexts.Context ctx) throws com.openexchange.exception.OXException
usm
- the user's mail settings to saveuser
- the user IDctx
- the contextcom.openexchange.exception.OXException
- if user's mail settings could not be savedpublic abstract void saveUserSettingMail(UserSettingMail usm, int user, com.openexchange.groupware.contexts.Context ctx, java.sql.Connection writeConArg) throws com.openexchange.exception.OXException
usm
- the user's mail settings to saveuser
- the user IDctx
- the contextwriteConArg
- - the writable connection; may be null
com.openexchange.exception.OXException
- if user's mail settings could not be savedpublic final void deleteUserSettingMail(int user, com.openexchange.groupware.contexts.Context ctx) throws com.openexchange.exception.OXException
user
- the user IDctx
- the contextcom.openexchange.exception.OXException
- if deletion failspublic abstract void deleteUserSettingMail(int user, com.openexchange.groupware.contexts.Context ctx, java.sql.Connection writeConArg) throws com.openexchange.exception.OXException
user
- the user IDctx
- the contextwriteConArg
- the writable connection; may be null
com.openexchange.exception.OXException
- - if deletion failspublic final UserSettingMail loadUserSettingMail(int user, com.openexchange.groupware.contexts.Context ctx) throws com.openexchange.exception.OXException
user
- the userctx
- the contextUserSettingMail
which matches given user ID and contextcom.openexchange.exception.OXException
- if loading failspublic abstract UserSettingMail loadUserSettingMail(int user, com.openexchange.groupware.contexts.Context ctx, java.sql.Connection readConArg) throws com.openexchange.exception.OXException
user
- the userctx
- the contextreadConArg
- the readable connectionUserSettingMail
which matches given user ID and contextcom.openexchange.exception.OXException
- if loading failspublic abstract void removeUserSettingMail(int user, com.openexchange.groupware.contexts.Context ctx) throws com.openexchange.exception.OXException
user
- the userctx
- the contextcom.openexchange.exception.OXException
- if cache removal failspublic abstract void clearStorage() throws com.openexchange.exception.OXException
com.openexchange.exception.OXException
- if cache clearing failspublic abstract void shutdownStorage()