Package com.avoka.fc.core.dao

Class OfflineClientSystemLogDao

java.lang.Object

com.avoka.core.dao.BaseDao

com.avoka.fc.core.dao.AbstractDao

com.avoka.fc.core.dao.OfflineClientSystemLogDao

public class OfflineClientSystemLogDao
extends AbstractDao

Provides a DAO for the OfflineClientSystemLog entity.

See Also:

OfflineClientSystemLog

Field Summary

Fields inherited from class com.avoka.core.dao.BaseDao

FETCH_LIMIT, STATEMENT_MAX_NO_PARAMETERS

Constructor Summary

Constructors

Constructor	Description
OfflineClientSystemLogDao()

Method Summary

Modifier and Type	Method	Description
OfflineClientSystemLog	createClientSystemLog(String systemLogData, String username, String ipAddress, String userAgent, String deviceInfo, Portal portal, String syncKey)	Create a new OfflineClientSystemLog entity.
OfflineClientSystemLog	getClientSystemLogForPK(Object id)	Return the OfflineClientSystemLog entry for the given id.
OfflineClientSystemLog	getClientSystemLogForSyncKey(String syncKey)	Return the offline client system log object for the given syncKey.
List<OfflineClientSystemLog>	getClientSystemLogList(String portalId, String loginUserName, String logMessage, String deviceInfo, Date startDate, Date endDate, int pageSize)	Return the list of OfflineClientSystemLog entries for the given search criteria.
List<OfflineClientSystemLog>	getClientSystemLogList(String portalId, String loginUserName, String logMessage, String deviceInfo, Date startDate, Date endDate, int pageSize, int fetchLimit)	Return the list of OfflineClientSystemLog entries for the given search criteria.
int	purgeOfflineSystemClientLog(int maxAgeDays, int fetchLimit)	Purge offline client system log records older than a specified number of days

Methods inherited from class com.avoka.fc.core.dao.AbstractDao

andFilterClientExcludeNull, andFilterClientIncludeNull, andFilterClientOnly, isClientAccessAllowed, performQueryConfigCached

Methods inherited from class com.avoka.core.dao.BaseDao

addOrdering, addOrderingCaseInsensitive, addOrderingCaseSensitive, andQueryBetween, andQueryInExp, andQueryInExp, andQueryLikeIgnoreCaseExp, andQueryMatchDbExp, andQueryMatchExp, andQueryMatchIsNotNull, andQueryMatchIsNull, andQueryNoMatchExp, andQueryNotTrue, deleteObject, deleteObjects, findObject, getDataContext, getFetchLimit, getLogger, getObjectForPK, newObject, orQueryLikeIgnoreCaseExp, orQueryMatchExp, performNamedQuery, performNamedQuery, performNamedQuery, performNamedQuery, performNonSelectingQuery, performNonSelectingQuery, performNonSelectingQuery, performNonSelectingQuery, performQuery, performQuery, performQuery, registerNewObject, setCacheStrategy, setFetchLimit, setLocalCacheStrategy, setLocalCacheStrategy, setSharedCacheStrategy, toMap, toMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OfflineClientSystemLogDao

public OfflineClientSystemLogDao()

Method Detail

getClientSystemLogForPK

public OfflineClientSystemLog getClientSystemLogForPK(Object id)

Return the OfflineClientSystemLog entry for the given id.

Parameters:

id - the entity id

Returns:

the OfflineClientSystemLog entry for the given id

getClientSystemLogForSyncKey

public OfflineClientSystemLog getClientSystemLogForSyncKey(String syncKey)

Return the offline client system log object for the given syncKey.

Parameters:

syncKey - the client generated GUID syncKey

Returns:

the offline client system log object for the given syncKey

Since:

4.1.0

getClientSystemLogList

public List<OfflineClientSystemLog> getClientSystemLogList(String portalId,
                                                           String loginUserName,
                                                           String logMessage,
                                                           String deviceInfo,
                                                           Date startDate,
                                                           Date endDate,
                                                           int pageSize)

Return the list of OfflineClientSystemLog entries for the given search criteria.

Parameters:

portalId - the OID of the portal for which the entries were logged (optional)

loginUserName - the user name of the user who initiated the synchronization (optional)

logMessage - a substring of the log message (optional)

deviceInfo - a device info (optional)

startDate - the lower bound on the synchronization time (optional)

endDate - the upper bound on the synchronization time (optional)

pageSize - the page size used in the query

Returns:

the list of OfflineClientSystemLog entries for the given search criteria

getClientSystemLogList

public List<OfflineClientSystemLog> getClientSystemLogList(String portalId,
                                                           String loginUserName,
                                                           String logMessage,
                                                           String deviceInfo,
                                                           Date startDate,
                                                           Date endDate,
                                                           int pageSize,
                                                           int fetchLimit)

Return the list of OfflineClientSystemLog entries for the given search criteria.

Parameters:

portalId - the OID of the portal for which the entries were logged (optional)

loginUserName - the user name of the user who initiated the synchronization (optional)

logMessage - a substring of the log message (optional)

deviceInfo - a device info (optional)

startDate - the lower bound on the synchronization time (optional)

endDate - the upper bound on the synchronization time (optional)

pageSize - the page size used in the query

fetchLimit - the query fetch limit

Returns:

the list of OfflineClientSystemLog entries for the given search criteria

Since:

4.3.0

createClientSystemLog

public OfflineClientSystemLog createClientSystemLog(String systemLogData,
                                                    String username,
                                                    String ipAddress,
                                                    String userAgent,
                                                    String deviceInfo,
                                                    Portal portal,
                                                    String syncKey)

Create a new OfflineClientSystemLog entity.

Parameters:

systemLogData - the MFW client system log data

username - the user login name

ipAddress - the client IP address

userAgent - the client browser user agent

deviceInfo - the client device info

portal - the portal of the request

syncKey - the client syncKey GUID

Returns:

the new OfflineClientSystemLog entity

purgeOfflineSystemClientLog

public int purgeOfflineSystemClientLog(int maxAgeDays,
                                       int fetchLimit)

Purge offline client system log records older than a specified number of days

Parameters:

maxAgeDays - The age in days above which records will be deleted. If this value is negative or equal to 0, no records will be purged.

fetchLimit - the maximum number of records to delete (only used if > 0)

Returns:

the number of records that were deleted