Package com.novomind.ecom.api.iagent.operation.newprocess

Interface CreateTicketOperationBuilder.WithRequired

All Superinterfaces:

IntermediateStorageProvider

Enclosing interface:

CreateTicketOperationBuilder

public static interface CreateTicketOperationBuilder.WithRequired
extends IntermediateStorageProvider

Builder stage that holds the required parameters for creating a new ticket.

Since:

12.25

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	CreateTicketOperationBuilder.WithRequired.CreateAndClose	Builder stage for creating a ticket and closing it without sending an answer.
static interface	CreateTicketOperationBuilder.WithRequired.CreateAndEnqueue	Builder stage for creating a ticket and enqueuing it in the backlog.
static interface	CreateTicketOperationBuilder.WithRequired.CreateAndSend	Builder stage for creating a ticket and sending an answer to it.

Method Summary

Modifier and Type	Method	Description
CreateTicketOperationBuilder.WithRequired	additionalToAddresses(List<jakarta.mail.internet.InternetAddress> additionalToAddresses)	Sets additional to-addresses of the new ticket.
CreateTicketOperationBuilder.WithRequired	attachments(List<String> attachmentNames)	Adds attachments to the message that will be created for the new ticket.
CreateTicketOperationBuilder.WithRequired	bccAddresses(List<jakarta.mail.internet.InternetAddress> bccAddresses)	Sets the bcc-addresses of the new ticket.
CreateTicketOperationBuilder.WithRequired	callId(Long callId)	Sets the id of the call to be associated with the new ticket.
CreateTicketOperationBuilder.WithRequired	causeId(Long causeId)	Deprecated.
CreateTicketOperationBuilder.WithRequired	ccAddresses(List<jakarta.mail.internet.InternetAddress> ccAddresses)	Sets the cc-addresses of the new ticket.
CreateTicketOperationBuilder.WithRequired	chatId(Long chatId)	Sets the id of the chat to be associated with the new ticket.
CreateTicketOperationBuilder.WithRequired	claimId(Long claimId)	Deprecated.
CreateTicketOperationBuilder.WithRequired	contact(Contact contact)	Sets the Contact of the new ticket.
CreateTicketOperationBuilder.WithRequired.CreateAndClose	createAndClose()	The newly created ticket will be closed without answer.
CreateTicketOperationBuilder.WithRequired.CreateAndEnqueue	createAndEnqueue()	The newly created ticket will be enqueued in the backlog.
CreateTicketOperationBuilder.WithRequired.CreateAndSend	createAndSend()	The newly created ticket will be answered with the given template.
CreateTicketOperationBuilder.WithRequired	editTime(Duration editTime)	Applies an edit time to the new ticket.
CreateTicketOperationBuilder.WithRequired	header(String headerName, String headerValue)	Adds custom headers to the message that will be created for the new ticket.
CreateTicketOperationBuilder.WithRequired	html(String html)	Sets the content for the message of the new ticket as html.
CreateTicketOperationBuilder.WithRequired	incomingChannel(Channel incomingChannel)	Sets the incoming channel of the new ticket.
CreateTicketOperationBuilder.WithRequired	language(Locale language)	Sets the language of the new ticket.
CreateTicketOperationBuilder.WithRequired	location(Location location)	Sets the Location of the new ticket.
CreateTicketOperationBuilder.WithRequired	primaryToAddress(jakarta.mail.internet.InternetAddress primaryToAddress)	Sets the primary to-address of the new ticket.
CreateTicketOperationBuilder.WithRequired	processId(Long processId)	Sets the id of the process to be associated with the new ticket.
CreateTicketOperationBuilder.WithRequired	replyToAddress(jakarta.mail.internet.InternetAddress replyToAddress)	Set the replyToAddress of the Account to send the answer.
CreateTicketOperationBuilder.WithRequired	subject(String subject)	Sets the subject of the new ticket.
CreateTicketOperationBuilder.WithRequired	template(MessageTemplate messageTemplate)	Sets the MessageTemplate for the message of the new ticket.
CreateTicketOperationBuilder.WithRequired	text(String text)	Sets the content for the message of the new ticket as plain text.

Methods inherited from interface com.novomind.ecom.api.iagent.provider.IntermediateStorageProvider

getIntermediateStorage

Method Details

createAndEnqueue

CreateTicketOperationBuilder.WithRequired.CreateAndEnqueue createAndEnqueue()
                                                                     throws ValidationException

The newly created ticket will be enqueued in the backlog.

Returns:

the CreateTicketOperationBuilder.WithRequired.CreateAndEnqueue

Throws:

ValidationException - if any parameters are not valid or missing

Since:

12.25

createAndSend

CreateTicketOperationBuilder.WithRequired.CreateAndSend createAndSend()
                                                               throws ValidationException

The newly created ticket will be answered with the given template.

Returns:

the CreateTicketOperationBuilder.WithRequired.CreateAndSend

Throws:

ValidationException - if any parameters are invalid or missing to create and send the answer or the category does not allow the close or answer operation

Since:

12.25

createAndClose

CreateTicketOperationBuilder.WithRequired.CreateAndClose createAndClose()
                                                                 throws ValidationException

The newly created ticket will be closed without answer.

Returns:

the CreateTicketOperationBuilder.WithRequired.CreateAndClose

Throws:

ValidationException - if any parameters are invalid or missing to create and close the ticket or the category does not allow the close operation

Since:

12.25

subject

CreateTicketOperationBuilder.WithRequired subject(String subject)
                                           throws ValidationException

Sets the subject of the new ticket. If a message template is also specified then the subject is used to fill the template.

Parameters:

subject - the subject of the new ticket

Returns:

the CreateTicketOperationBuilder.WithRequired

Throws:

ValidationException - if the subject is not valid

Since:

12.25

text

CreateTicketOperationBuilder.WithRequired text(String text)
                                        throws ValidationException

Sets the content for the message of the new ticket as plain text. If a message template is also specified then the text is used to fill the template.

Parameters:

text - the plain text content for the message of the new ticket

Returns:

the CreateTicketOperationBuilder.WithRequired

Throws:

ValidationException - if the text is not valid

Since:

12.25

html

CreateTicketOperationBuilder.WithRequired html(String html)
                                        throws ValidationException

Sets the content for the message of the new ticket as html. If a message template is also specified then the html is used to fill the template.

Parameters:

html - the html content for the message of the new ticket

Returns:

the CreateTicketOperationBuilder.WithRequired

Throws:

ValidationException - if the html is not valid

Since:

12.25

incomingChannel

CreateTicketOperationBuilder.WithRequired incomingChannel(Channel incomingChannel)
                                                   throws ValidationException

Sets the incoming channel of the new ticket. If no incomingChannel is specified then the default channel is EMAIL.

Parameters:

incomingChannel - the incomingChannel of new ticket

Returns:

the CreateTicketOperationBuilder.WithRequired

Throws:

ValidationException - if the incomingChannel is not valid

Since:

12.25

template

CreateTicketOperationBuilder.WithRequired template(MessageTemplate messageTemplate)
                                            throws ValidationException

Sets the MessageTemplate for the message of the new ticket.

Parameters:

messageTemplate - the MessageTemplate for the message of the new ticket

Returns:

the CreateTicketOperationBuilder.WithRequired

Throws:

ValidationException - if the messageTemplate is not valid or inappropriate

Since:

12.25

language

CreateTicketOperationBuilder.WithRequired language(Locale language)
                                            throws ValidationException

Sets the language of the new ticket. Please note that only the language attribute of the given Locale is used.

Parameters:

language - the language of the new ticket

Returns:

the CreateTicketOperationBuilder.WithRequired

Throws:

ValidationException - if the language is not valid

Since:

12.25

location

CreateTicketOperationBuilder.WithRequired location(Location location)
                                            throws ValidationException

Sets the Location of the new ticket.

Parameters:

location - the Location of the new ticket

Returns:

the CreateTicketOperationBuilder.WithRequired

Throws:

ValidationException - if the Location is not valid

Since:

12.25

contact

CreateTicketOperationBuilder.WithRequired contact(Contact contact)
                                           throws ValidationException

Sets the Contact of the new ticket.

Parameters:

contact - the Contact of the new ticket

Returns:

the CreateTicketOperationBuilder.WithRequired

Throws:

ValidationException - if the Contact is not valid

Since:

12.25

processId

CreateTicketOperationBuilder.WithRequired processId(Long processId)
                                             throws ValidationException

Sets the id of the process to be associated with the new ticket.

Parameters:

processId - the processId of the process to be assigned to the new ticket

Returns:

the CreateTicketOperationBuilder.WithRequired

Throws:

ValidationException - if the processId is not valid

Since:

12.25

callId

CreateTicketOperationBuilder.WithRequired callId(Long callId)
                                          throws ValidationException

Sets the id of the call to be associated with the new ticket.

Parameters:

callId - the callId of the Call to be associated with the new ticket

Returns:

the CreateTicketOperationBuilder.WithRequired

Throws:

ValidationException - if the callId is not valid

Since:

12.25

chatId

CreateTicketOperationBuilder.WithRequired chatId(Long chatId)
                                          throws ValidationException

Sets the id of the chat to be associated with the new ticket.

Parameters:

chatId - the chatId of the chat to be associated with the new ticket

Returns:

the CreateTicketOperationBuilder.WithRequired

Throws:

ValidationException - if the chatId is not valid

Since:

13.9

claimId

@Deprecated
CreateTicketOperationBuilder.WithRequired claimId(Long claimId)
                                           throws ValidationException

Deprecated.

Sets the id of the Claim to be associated with the new ticket.

Parameters:

claimId - the claimId of the Claim to be assigned to the new ticket

Returns:

the CreateTicketOperationBuilder.WithRequired

Throws:

ValidationException - if the claimId is not valid

Since:

12.25

causeId

@Deprecated
CreateTicketOperationBuilder.WithRequired causeId(Long causeId)
                                           throws ValidationException

Deprecated.

Sets the id of the Cause to be associated with the new ticket. Valid causeId's are: 1 - default for manually created tickets 4 - phone ticket 8 - chat ticket created due to a chat 10 - new ticket created by API (default)

Parameters:

causeId - the causeId of the Cause to be assigned to the new ticket

Returns:

the CreateTicketOperationBuilder.WithRequired

Throws:

ValidationException - if the causeId is not valid

Since:

12.25

replyToAddress

CreateTicketOperationBuilder.WithRequired replyToAddress(jakarta.mail.internet.InternetAddress replyToAddress)
                                                  throws ValidationException

Set the replyToAddress of the Account to send the answer. The replyToAddress must be assigned to the previously specified account. Otherwise a ValidationException will be thrown.

Parameters:

replyToAddress - the replyToAddress of the specified account

Returns:

the CreateTicketOperationBuilder.WithRequired

Throws:

ValidationException - if the replyToAddress is not valid or not assigned to the Account

Since:

12.25

primaryToAddress

CreateTicketOperationBuilder.WithRequired primaryToAddress(jakarta.mail.internet.InternetAddress primaryToAddress)
                                                    throws ValidationException

Sets the primary to-address of the new ticket. The primary to-address is required to create the new ticket.

Parameters:

primaryToAddress - the primary to-address of the new ticket

Returns:

the CreateTicketOperationBuilder.WithRequired

Throws:

ValidationException - if the primary to-address is not valid

Since:

12.25

additionalToAddresses

CreateTicketOperationBuilder.WithRequired additionalToAddresses(List<jakarta.mail.internet.InternetAddress> additionalToAddresses)
                                                         throws ValidationException

Sets additional to-addresses of the new ticket.

Parameters:

additionalToAddresses - the additional to-addresses of the new ticket

Returns:

the CreateTicketOperationBuilder.WithRequired

Throws:

ValidationException - if the additional to-addresses are not valid

Since:

12.25

ccAddresses

CreateTicketOperationBuilder.WithRequired ccAddresses(List<jakarta.mail.internet.InternetAddress> ccAddresses)
                                               throws ValidationException

Sets the cc-addresses of the new ticket.

Parameters:

ccAddresses - the cc-addresses of the new ticket

Returns:

the CreateTicketOperationBuilder.WithRequired

Throws:

ValidationException - if the cc-addresses are not valid

Since:

12.25

bccAddresses

CreateTicketOperationBuilder.WithRequired bccAddresses(List<jakarta.mail.internet.InternetAddress> bccAddresses)
                                                throws ValidationException

Sets the bcc-addresses of the new ticket.

Parameters:

bccAddresses - the bcc-addresses of the new ticket

Returns:

the CreateTicketOperationBuilder.WithRequired

Throws:

ValidationException - if the bcc-addresses are not valid

Since:

12.25

header

CreateTicketOperationBuilder.WithRequired header(String headerName,
 String headerValue)
                                          throws ValidationException

Adds custom headers to the message that will be created for the new ticket.

Parameters:

headerName - the name of the header to be added to the message

headerValue - the value of the header to be added to the message

Returns:

the CreateTicketOperationBuilder.WithRequired

Throws:

ValidationException - if the headerName or headerValue are not valid

Since:

12.25

attachments

CreateTicketOperationBuilder.WithRequired attachments(List<String> attachmentNames)
                                               throws ValidationException

Adds attachments to the message that will be created for the new ticket. Please note that the attachments given by the names in the list must be available on the novomind iAGENT server as global attachment.

Parameters:

attachmentNames - the List of attachment names to be added to the message

Returns:

the CreateTicketOperationBuilder.WithRequired

Throws:

ValidationException - if the attachmentName is not valid

Since:

12.25

editTime

CreateTicketOperationBuilder.WithRequired editTime(Duration editTime)
                                            throws ValidationException

Applies an edit time to the new ticket.

Parameters:

editTime - the edit time to be added to the new ticket.

Returns:

the CreateTicketOperationBuilder.WithRequired

Throws:

ValidationException - if the editTime is not valid

Since:

12.25