Interface IFormRecordChatHandler
-
- All Superinterfaces:
IAPIHandler
,IGenericHandler
,Serializable
- All Known Implementing Classes:
FormRecordChatHandler
public interface IFormRecordChatHandler extends IGenericHandler
Handler forFormRecordChat
entities- Since:
- 8.2.0
- Author:
- XIMA Media GmbH
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description List<FormRecordChat>
getAllByRecord(UserContext uc, String recordUuid)
Finds all chats for the form record given by its UUID.PagedResult<FormRecordChat>
getByRecordAndUser(UserContext uc, UUID recordUuid, IUser user, int page, int pageSize)
Finds the chats for the form record given by its UUID if the given user can access the chat.List<FormRecordChat>
getByUser(UserContext uc, IUser user)
Finds all form record chats the given userhas access to
.PagedResult<FormRecordChat>
getByUser(UserContext uc, IUser user, int page, int pageSize)
Finds all form record chats the given user has access to via the public REST API.FormRecordChat
getByUuid(UserContext uc, UUID uuid)
Finds the chat for the given UUID.FormRecordChat
getByUuidAndUser(UserContext uc, UUID uuid, IUser user)
Finds the chat for the given UUID if the given user can access the chat.-
Methods inherited from interface de.xima.fc.com.interfaces.IAPIHandler
getName
-
Methods inherited from interface de.xima.fc.handler.interfaces.entity.IGenericHandler
create, create, delete, delete, deleteBy, deleteById, deleteById, getAll, getAllBy, getAttributes, getAttributes, getBy, getById, getById, getById, getEntityRefs, getSingleAttributes, getSingleAttributes, resultTotalCount, update, update
-
-
-
-
Method Detail
-
getByUuid
FormRecordChat getByUuid(UserContext uc, UUID uuid)
Finds the chat for the given UUID.- Parameters:
uc
- user context for accessing the databaseuuid
- the UUID of the chat- Returns:
- The chat with the given UUID
-
getByUuidAndUser
FormRecordChat getByUuidAndUser(UserContext uc, UUID uuid, IUser user)
Finds the chat for the given UUID if the given user can access the chat.- Parameters:
uc
- user context for database transactions.uuid
- the UUID of the chatuser
- user to get the chat for.- Returns:
- The chat with the given UUID if it exists and the user can access it.
null
otherwise. - See Also:
getByUser(UserContext, IUser)
-
getByUser
List<FormRecordChat> getByUser(UserContext uc, IUser user)
Finds all form record chats the given userhas access to
.- Parameters:
uc
- user context for database transactions.user
- user to get the chats for.- Returns:
- a list of the user's form record chats ordered by their creation instant (desc).
- See Also:
FormRecordChat.isMember(IUser)
-
getByUser
PagedResult<FormRecordChat> getByUser(UserContext uc, IUser user, int page, int pageSize)
Finds all form record chats the given user has access to via the public REST API.- Parameters:
uc
- user context for database transactions.user
- user to get the chats for.page
- to get.pageSize
- size of the page to get.- Returns:
- a list of the user's form record chats ordered by their creation instant (desc).
- See Also:
getByUser(UserContext, IUser)
-
getByRecordAndUser
PagedResult<FormRecordChat> getByRecordAndUser(UserContext uc, UUID recordUuid, IUser user, int page, int pageSize)
Finds the chats for the form record given by its UUID if the given user can access the chat.- Parameters:
uc
- user context for accessing the database.recordUuid
- the UUID of the form recorduser
- to get the form record chats for.page
- to get.pageSize
- size of the page to get.- Returns:
- a list of form record chats the user has access to ordered by their creation instant (desc).
null
if the form record given by the UUID could not be found. - See Also:
getByUser(UserContext, IUser)
-
getAllByRecord
List<FormRecordChat> getAllByRecord(UserContext uc, String recordUuid)
Finds all chats for the form record given by its UUID.- Parameters:
uc
- user context for accessing the database.recordUuid
- the UUID of the form record- Returns:
- a list of form record chats ordered by their creation instant (desc).
null
if the form record given by the UUID could not be found.
-
-