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 writing FormRecordChat entities.

Since:

8.2.0

Author:

XIMA Media GmbH

See Also:

• Serialized Form

Field Summary

Fields inherited from class GenericHandler

LOG

Constructor Summary

Constructors

Constructor	Description
FormRecordChatHandler()

Method Summary

Modifier and Type	Method	Description
List<FormRecordChat>	getAllByRecord(UserContext uc, String recordUuid)	Finds all chats for the form record given by its UUID.
PagedResult<BaseFormRecordChatDTO>	getByRecordAndUser(UserContext uc, UUID recordUuid, IUser user, int page, int pageSize, Locale locale)	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 user has access to.
PagedResult<FormRecordChat>	getByUser(UserContext uc, IUser user, int page, int pageSize, int offset)	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.
DetailedFormRecordChatDTO	getDetailsByUuidAndUser(UserContext uc, UUID uuid, IUser user, Locale locale)	Finds the chat for the given UUID if the given user can access the chat.
PagedResult<BaseFormRecordChatDTO>	getFormRecordChatsPage(UserContext uc, PageQuery page, FormRecordChatsQuery query, boolean skipCount)	Finds all form record chats that match the given query.
void	markReadByEndUser(UserContext uc, UUID chatUuid, IUser user)	Marks the chat as read for the given end user.
void	markReadByInboxUser(UserContext uc, UUID chatUuid, IUser user)	Marks the chat as read for the given inbox user.

Methods inherited from class 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 AMSApiHandler

getName

Methods inherited from class Object

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

Methods inherited from interface IAPIHandler

getName

Methods inherited from interface IGenericHandler

create, create, delete, delete, deleteBy, deleteById, deleteById, getAll, getAllBy, getAttributes, getAttributes, getBy, getById, getById, getById, getEntityRefs, getSingleAttributes, getSingleAttributes, resultTotalCount, update, update

Constructor Details

FormRecordChatHandler

public FormRecordChatHandler()

Method Details

getByUuid

public FormRecordChat getByUuid(UserContext uc,
 UUID uuid)

Description copied from interface: IFormRecordChatHandler

Finds the chat for the given UUID.

Specified by:

getByUuid in interface IFormRecordChatHandler

Parameters:

uc - user context for accessing the database

uuid - 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 interface IFormRecordChatHandler

Parameters:

uc - user context for database transactions.

uuid - the UUID of the chat

user - 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)

getDetailsByUuidAndUser

public DetailedFormRecordChatDTO getDetailsByUuidAndUser(UserContext uc,
 UUID uuid,
 IUser user,
 Locale locale)

Description copied from interface: IFormRecordChatHandler

Finds the chat for the given UUID if the given user can access the chat.

Specified by:

getDetailsByUuidAndUser in interface IFormRecordChatHandler

Parameters:

uc - user context for database transactions.

uuid - the UUID of the chat

user - user to get the chat for.

locale - the locale to use for the DTO.

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 user has access to.

Specified by:

getByUser in interface IFormRecordChatHandler

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,
 int offset)

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 interface IFormRecordChatHandler

Parameters:

uc - user context for database transactions.

user - user to get the chats for.

page - to get. Identifies the page by page number. The first page number is 1.

pageSize - size of the page to get.

offset - The number of form record chats to skip before starting to collect the result. The offset starts at the beginning of the page given by the page number parameter.

Returns:

a list of the user's form record chats ordered by their creation instant (desc).

See Also:

• IFormRecordChatHandler.getByUser(UserContext, IUser)

getFormRecordChatsPage

public PagedResult<BaseFormRecordChatDTO> getFormRecordChatsPage(UserContext uc,
 PageQuery page,
 FormRecordChatsQuery query,
 boolean skipCount)

Description copied from interface: IFormRecordChatHandler

Finds all form record chats that match the given query.

Specified by:

getFormRecordChatsPage in interface IFormRecordChatHandler

Parameters:

uc - user context for accessing the database.

page - to get.

query - to filter the form record chats.

skipCount - whether to skip the count query.

Returns:

a list of form record chats that match the query ordered by their creation instant (desc).

markReadByEndUser

public void markReadByEndUser(UserContext uc,
 UUID chatUuid,
 IUser user)

Description copied from interface: IFormRecordChatHandler

Marks the chat as read for the given end user.

Specified by:

markReadByEndUser in interface IFormRecordChatHandler

Parameters:

uc - user context for accessing the database.

chatUuid - the UUID of the chat

user - the end user to mark the chat as read for.

markReadByInboxUser

public void markReadByInboxUser(UserContext uc,
 UUID chatUuid,
 IUser user)

Description copied from interface: IFormRecordChatHandler

Marks the chat as read for the given inbox user.

Specified by:

markReadByInboxUser in interface IFormRecordChatHandler

Parameters:

uc - user context for accessing the database.

chatUuid - the UUID of the chat

user - the inbox user to mark the chat as read for.

getByRecordAndUser

public PagedResult<BaseFormRecordChatDTO> getByRecordAndUser(UserContext uc,
 UUID recordUuid,
 IUser user,
 int page,
 int pageSize,
 Locale locale)

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 interface IFormRecordChatHandler

Parameters:

uc - user context for accessing the database.

recordUuid - the UUID of the form record

user - 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 interface IFormRecordChatHandler

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.