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

Interface CloseOperationBuilder.WithTicket

Enclosing interface:

CloseOperationBuilder

public static interface CloseOperationBuilder.WithTicket

Builder stage that holds the selected ticket.

Since:

11.28

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	CloseOperationBuilder.WithTicket.AsAgent	Builder stage for agent-executed ticket close operations.
static interface	CloseOperationBuilder.WithTicket.AsSupervisor	Builder stage for supervisor-executed ticket close operations.
static interface	CloseOperationBuilder.WithTicket.WithTransactionCode	Builder stage that holds the selected transaction code.

Method Summary

Modifier and Type	Method	Description
CloseOperationBuilder.WithTicket.AsAgent	agent(User user)	Sets the agent user for this close operation.
CloseOperationBuilder.WithTicket.AsSupervisor	supervisor(User user)	Sets the supervisor user for this close operation.
CloseOperationBuilder.WithTicket.WithTransactionCode	transactionCode(TransactionCode transactionCode)	Sets the transaction code for this close operation.

Method Details

transactionCode

CloseOperationBuilder.WithTicket.WithTransactionCode transactionCode(TransactionCode transactionCode)
                                                              throws ValidationException

Sets the transaction code for this close operation.

Parameters:

transactionCode - the transaction code for the close operation.

Returns:

the CloseOperationBuilder.WithTicket.WithTransactionCode

Throws:

ValidationException - e.g. if the transaction code is invalid or the transaction code is not assigned to the category of the ticket.

Since:

11.28

supervisor

CloseOperationBuilder.WithTicket.AsSupervisor supervisor(User user)
                                                  throws ValidationException

Sets the supervisor user for this close operation.

Parameters:

user - the user executing the operation

Returns:

the CloseOperationBuilder.WithTicket.AsSupervisor

Throws:

ValidationException - e.g. if the specified user is invalid, deleted or not a supervisor for the category of the ticket or the ticket is in a state which disallows being closed by a supervisor.

Since:

11.28

agent

CloseOperationBuilder.WithTicket.AsAgent agent(User user)
                                        throws ValidationException

Sets the agent user for this close operation.

Parameters:

user - the user executing the operation

Returns:

the CloseOperationBuilder.WithTicket.AsAgent

Throws:

ValidationException - e.g. if the specified user is invalid, deleted, not logged in, not an agent or the ticket is not in the inbox of the user.

Since:

11.28