Package de.xima.fc.dao.interfaces
Interface IFormRecordMessageDao
-
- All Superinterfaces:
de.xima.cmn.dao.interfaces.IAbstractDao<FormRecordMessage,Long,IEntityContext>
,IGenericDao<FormRecordMessage>
- All Known Implementing Classes:
FormRecordMessageDao
public interface IFormRecordMessageDao extends IGenericDao<FormRecordMessage>
DAO for reading and writingFormRecordMessage
entities.- Since:
- 8.2.0
- Author:
- XIMA Media GmbH
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description List<FormRecordMessage>
getAllBySenderUserProfile(IEntityContext ec, UserProfile sender)
Returns all messages sent by the given user profile.PagedResult<FormRecordMessage>
getByChatAndUser(IEntityContext ec, UUID chatUuid, IUser user, int page, int pageSize)
Finds the messages for the form record chat given by its UUID if the given usercan access the chat
.List<FormRecordMessage>
getByUser(IEntityContext ec, IUser user)
Returns all messages the given user has access to.PagedResult<FormRecordMessage>
getByUser(IEntityContext ec, IUser user, int page, int pageSize)
Finds all form record messages the given user has access to.FormRecordMessage
getByUuid(IEntityContext ec, UUID uuid)
Finds the message for the given UUID.FormRecordMessage
getByUuidAndUser(IEntityContext ec, UUID uuid, IUser requestingUser)
Finds the message for the given UUID, which the givenuser can access
.PagedResult<FormRecordMessage>
getUnreadByUser(IEntityContext ec, IUser user, int page, int pageSize)
Finds all unread form record messages the given user has access to.-
Methods inherited from interface de.xima.cmn.dao.interfaces.IAbstractDao
all, bulkDelete, bulkUpdate, checkLockingVersion, create, create, delete, delete, deleteAll, executePagedDaoAction, getAttributes, getAttributes, getSingleAttributes, getSingleAttributes, getTransactionHandler, read, registerListener, registerListener, registerListener, resultTotalCount, setTransactionHandler, singleElement, unregisterListener, unregisterListener, unregisterListener, update, update
-
Methods inherited from interface de.xima.fc.dao.interfaces.IGenericDao
count, findAll, findSingle, getEntityRefs, read
-
-
-
-
Method Detail
-
getByUuid
FormRecordMessage getByUuid(IEntityContext ec, UUID uuid)
Finds the message for the given UUID.- Parameters:
ec
- entity context for accessing the databaseuuid
- the UUID of the message- Returns:
- The message with the given UUID
-
getByUuidAndUser
FormRecordMessage getByUuidAndUser(IEntityContext ec, UUID uuid, IUser requestingUser)
Finds the message for the given UUID, which the givenuser can access
.- Parameters:
ec
- entity context for accessing the databaseuuid
- the UUID of the messagerequestingUser
- user requesting the messages.- Returns:
- The message with the given UUID which the given user can access and
null
otherwise. - See Also:
getByUser(IEntityContext, IUser)
-
getByUser
List<FormRecordMessage> getByUser(IEntityContext ec, IUser user)
Returns all messages the given user has access to. The user has access to all messages ofchats they have access
to.- Parameters:
ec
- entity context for accessing the database.user
- requesting the messages.- Returns:
- a list of form record messages ordered by their
sent instant
(desc). - See Also:
IFormRecordChatDao.getByUser(IEntityContext, IUser)
-
getByUser
PagedResult<FormRecordMessage> getByUser(IEntityContext ec, IUser user, int page, int pageSize)
Finds all form record messages the given user has access to.- Parameters:
ec
- entity context for database transactions.user
- to get the form record messages for.page
- to get.pageSize
- size of the page to get.- Returns:
- a list of form record messages the user has access to ordered by their creation instant (desc).
- See Also:
getByUser(IEntityContext, IUser)
-
getUnreadByUser
PagedResult<FormRecordMessage> getUnreadByUser(IEntityContext ec, IUser user, int page, int pageSize)
Finds all unread form record messages the given user has access to. Unread messages can only be gotten for users withUserProfile
s. For users without a profile all messages will be returned.- Parameters:
ec
- entity context for database transactions.user
- to get the unread form record messages for.page
- to get.pageSize
- size of the page to get.- Returns:
- a list of form record messages the user has access to ordered by their creation instant (desc).
- See Also:
getByUser(IEntityContext, IUser)
-
getByChatAndUser
PagedResult<FormRecordMessage> getByChatAndUser(IEntityContext ec, UUID chatUuid, IUser user, int page, int pageSize)
Finds the messages for the form record chat given by its UUID if the given usercan access the chat
.- Parameters:
ec
- entity context for accessing the database.chatUuid
- the UUID of the chatuser
- to get the form record messages for.page
- to get.pageSize
- size of the page to get.- Returns:
- a list of form record messages the user has access to ordered by their creation instant (desc).
null
if the chat given by the UUID could not be found. - See Also:
getByUser(IEntityContext, IUser)
-
getAllBySenderUserProfile
List<FormRecordMessage> getAllBySenderUserProfile(IEntityContext ec, UserProfile sender)
Returns all messages sent by the given user profile.- Parameters:
ec
- the entity contextsender
- the user profile of the sender- Returns:
- all messages of the sender
-
-