Package com.novomind.ecom.api.imail.routing.operation.close

Interface CloseOperationBuilder

public interface CloseOperationBuilder

The CloseOperationBuilder provides specific builders to build a close operation on a ticket or chat. Please note that plugins running in the novomind iAGENT mail agent process will not be called, e.g. AgentTicketActionValidator and AgentChatActionValidator plugins cannot prevent tickets and chats from being closed.

Since:

11.28

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	CloseOperationBuilder.WithChat	Builder stage that holds the selected chat.
static interface	CloseOperationBuilder.WithTicket	Builder stage that holds the selected ticket.

Method Summary

Modifier and Type	Method	Description
CloseOperationBuilder.WithChat	chat(Chat chat)	Sets the chat to be closed.
CloseOperationBuilder.WithChat	chat(Long chatId)	Sets the chat to be closed by its id.
CloseOperationBuilder.WithTicket	ticket(Ticket ticket)	Sets the ticket to be closed.
CloseOperationBuilder.WithTicket	ticket(Long ticketId)	Sets the ticket to be closed by its id.

Method Details

ticket

CloseOperationBuilder.WithTicket ticket(Long ticketId)
                                 throws ValidationException

Sets the ticket to be closed by its id.

Parameters:

ticketId - the ticketId of the ticket to be closed.

Returns:

the CloseOperationBuilder.WithTicket

Throws:

ValidationException - if the ticketId is invalid.

Since:

11.28

ticket

CloseOperationBuilder.WithTicket ticket(Ticket ticket)
                                 throws ValidationException

Sets the ticket to be closed.

Parameters:

ticket - the ticket to be closed.

Returns:

the CloseOperationBuilder.WithTicket

Throws:

ValidationException - if the ticket is invalid.

Since:

11.28

chat

CloseOperationBuilder.WithChat chat(Long chatId)
                             throws ValidationException

Sets the chat to be closed by its id.

Parameters:

chatId - the chatId of the chat to be closed.

Returns:

the CloseOperationBuilder.WithChat

Throws:

ValidationException - if the chatId is invalid.

Since:

12.23

chat

CloseOperationBuilder.WithChat chat(Chat chat)
                             throws ValidationException

Sets the chat to be closed.

Parameters:

chat - the chat to be closed.

Returns:

the CloseOperationBuilder.WithChat

Throws:

ValidationException - if the chat is invalid.

Since:

12.23