Package de.xima.fc.handler.entity
Class FormRecordChatHandler
- java.lang.Object
-
- de.xima.fc.handler.AMSApiHandler
-
- de.xima.fc.handler.entity.GenericHandler
-
- de.xima.fc.handler.entity.FormRecordChatHandler
-
- All Implemented Interfaces:
IAPIHandler
,IFormRecordChatHandler
,IGenericHandler
,Serializable
public class FormRecordChatHandler extends GenericHandler implements IFormRecordChatHandler
Handler implementation for reading and writingFormRecordChat
entities.- Since:
- 8.2.0
- Author:
- XIMA Media GmbH
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class de.xima.fc.handler.entity.GenericHandler
LOG
-
-
Constructor Summary
Constructors Constructor Description FormRecordChatHandler()
-
Method Summary
All Methods Instance Methods Concrete 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 class de.xima.fc.handler.entity.GenericHandler
create, create, delete, delete, deleteBy, deleteById, deleteById, getAll, getAllBy, getAttributes, getAttributes, getBy, getById, getById, getById, getEntityRefs, getSingleAttributes, getSingleAttributes, resultTotalCount, serializableList, update, update
-
Methods inherited from class de.xima.fc.handler.AMSApiHandler
getName
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
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
public FormRecordChat getByUuid(UserContext uc, UUID uuid)
Description copied from interface:IFormRecordChatHandler
Finds the chat for the given UUID.- Specified by:
getByUuid
in interfaceIFormRecordChatHandler
- Parameters:
uc
- user context for accessing the databaseuuid
- the UUID of the chat- Returns:
- The chat with the given UUID
-
getByUuidAndUser
public FormRecordChat getByUuidAndUser(UserContext uc, UUID uuid, IUser user)
Description copied from interface:IFormRecordChatHandler
Finds the chat for the given UUID if the given user can access the chat.- Specified by:
getByUuidAndUser
in interfaceIFormRecordChatHandler
- 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:
IFormRecordChatHandler.getByUser(UserContext, IUser)
-
getByUser
public List<FormRecordChat> getByUser(UserContext uc, IUser user)
Description copied from interface:IFormRecordChatHandler
Finds all form record chats the given userhas access to
.- Specified by:
getByUser
in interfaceIFormRecordChatHandler
- 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
public PagedResult<FormRecordChat> getByUser(UserContext uc, IUser user, int page, int pageSize)
Description copied from interface:IFormRecordChatHandler
Finds all form record chats the given user has access to via the public REST API.- Specified by:
getByUser
in interfaceIFormRecordChatHandler
- 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:
IFormRecordChatHandler.getByUser(UserContext, IUser)
-
getByRecordAndUser
public PagedResult<FormRecordChat> getByRecordAndUser(UserContext uc, UUID recordUuid, IUser user, int page, int pageSize)
Description copied from interface:IFormRecordChatHandler
Finds the chats for the form record given by its UUID if the given user can access the chat.- Specified by:
getByRecordAndUser
in interfaceIFormRecordChatHandler
- 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:
IFormRecordChatHandler.getByUser(UserContext, IUser)
-
getAllByRecord
public List<FormRecordChat> getAllByRecord(UserContext uc, String recordUuid)
Description copied from interface:IFormRecordChatHandler
Finds all chats for the form record given by its UUID.- Specified by:
getAllByRecord
in interfaceIFormRecordChatHandler
- 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.
-
-