de.hybris.platform.ticket.strategies.impl

Class DefaultTicketUpdateStrategy

java.lang.Object

de.hybris.platform.ticket.strategies.impl.DefaultTicketUpdateStrategy

All Implemented Interfaces:

TicketUpdateStrategy

public class DefaultTicketUpdateStrategy
extends java.lang.Object
implements TicketUpdateStrategy

Constructor Summary

Constructors

Constructor and Description
DefaultTicketUpdateStrategy()

Method Summary

Modifier and Type	Method and Description
CsTicketEventModel	assignTicketToAgent(CsTicketModel ticket, EmployeeModel agent) Assign the ticket to a new agent, or null to make the ticket unassigned.
CsTicketEventModel	assignTicketToGroup(CsTicketModel ticket, CsAgentGroupModel group) Assign the ticket to a new group, or null to make the ticket unassigned.
protected CsTicketEventModel	createAssignTicketEvent(CsTicketModel ticket, java.util.Set<CsTicketChangeEventEntryModel> changedValues)
protected CsTicketEventModel	createChangeEvent(CsTicketModel ticket, java.util.Set<CsTicketChangeEventEntryModel> changedValues)
protected CsTicketEventModel	createChangeEvent(CsTicketModel ticket, java.util.Set<CsTicketChangeEventEntryModel> changedValues, java.lang.String note)
protected ItemModelContextImpl	getContext(AbstractItemModel model)
protected ModelService	getModelService()
java.lang.String	getTicketAssigndEventType()
java.util.List<CsTicketState>	getTicketNextStates(CsTicketState currentState) Get a list of legal states that a ticket can move into.
protected boolean	isValidStateTransition(CsTicketState oldState, CsTicketState newState)
protected void	preChangeTicketAssignment(CsTicketModel ticket, EmployeeModel agent)
protected void	preChangeTicketGroup(CsTicketModel ticket, CsAgentGroupModel group)
protected void	preSetTicketState(CsTicketModel ticket, CsTicketState newState)
void	setAvailableNextStates(java.util.Map<CsTicketState,java.util.List<CsTicketState>> availableNextStates)
void	setModelService(ModelService modelService)
void	setTicketAssigndEventType(java.lang.String ticketAssigndEventType)
void	setTicketAttributeChangeEventStrategy(TicketAttributeChangeEventStrategy ticketAttributeChangeEventStrategy)
void	setTicketChangeEventType(java.lang.String ticketChangeEventType)
void	setTicketEventFactory(TicketEventFactory ticketEventFactory)
void	setTicketState(CsTicketModel ticket, CsTicketState newState) Set the state of the ticket.
void	setTicketState(CsTicketModel ticket, CsTicketState newState, java.lang.String note) Set the state of the ticket.
CsTicketModel	updateTicket(CsTicketModel ticket) Store all updated attributes on a ticket.
CsTicketModel	updateTicket(CsTicketModel ticket, java.lang.String note) Store all updated attributes on a ticket.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultTicketUpdateStrategy

public DefaultTicketUpdateStrategy()

Method Detail

updateTicket

public CsTicketModel updateTicket(CsTicketModel ticket)
                           throws TicketException

Description copied from interface: TicketUpdateStrategy

Store all updated attributes on a ticket. This method should run business rules to confirm that the changes made are legal. If the update is not permitted an exception is thrown.

Specified by:

updateTicket in interface TicketUpdateStrategy

Parameters:

ticket - The ticket to be updated

Returns:

The updated ticket

Throws:

TicketException - If the update is not permitted

updateTicket

public CsTicketModel updateTicket(CsTicketModel ticket,
                                  java.lang.String note)
                           throws TicketException

Description copied from interface: TicketUpdateStrategy

Store all updated attributes on a ticket. This method also allows a note to be added to the ticket with the update. This method should run business rules to confirm that the changes made are legal. If the update is not permitted an exception is thrown.

Specified by:

updateTicket in interface TicketUpdateStrategy

Parameters:

ticket - The ticket to be updated

note - The text of the note to add along with the update

Returns:

The updated ticket

Throws:

TicketException - If the update is not permitted

setTicketState

public void setTicketState(CsTicketModel ticket,
                           CsTicketState newState)
                    throws TicketException

Description copied from interface: TicketUpdateStrategy

Set the state of the ticket. This method should run any business rules associated with state change. This method should also guarantee that it won't have the side effect of storing any other changes to the ticket and should throw an exception if the ticket has been otherwise updated.

Specified by:

setTicketState in interface TicketUpdateStrategy

Parameters:

ticket - The ticket to update the state of

newState - The state to set the ticket to

Throws:

TicketException - If the ticket has been modified or the state transition is illegal

See Also:

getTicketNextStates to get list of possible state transitions

setTicketState

public void setTicketState(CsTicketModel ticket,
                           CsTicketState newState,
                           java.lang.String note)
                    throws TicketException

Description copied from interface: TicketUpdateStrategy

Set the state of the ticket. This method should run any business rules associated with state change. This method should also guarantee that it won't have the side effect of storing any other changes to the ticket and should throw an exception if the ticket has been otherwise updated.

Specified by:

setTicketState in interface TicketUpdateStrategy

Parameters:

ticket - The ticket to update the state of

newState - The state to set the ticket to

note - The text of the note to add along with the state change

Throws:

TicketException - If the ticket has been modified or the state transition is illegal

See Also:

getTicketNextStates to get list of possible state transitions

getTicketNextStates

public java.util.List<CsTicketState> getTicketNextStates(CsTicketState currentState)

Description copied from interface: TicketUpdateStrategy

Get a list of legal states that a ticket can move into.

Specified by:

getTicketNextStates in interface TicketUpdateStrategy

Parameters:

currentState - The starting state

Returns:

a list of states that the ticket can move to next.

isValidStateTransition

protected boolean isValidStateTransition(CsTicketState oldState,
                                         CsTicketState newState)

preSetTicketState

protected void preSetTicketState(CsTicketModel ticket,
                                 CsTicketState newState)
                          throws TicketException

Throws:

TicketException

assignTicketToAgent

public CsTicketEventModel assignTicketToAgent(CsTicketModel ticket,
                                              EmployeeModel agent)
                                       throws TicketException

Description copied from interface: TicketUpdateStrategy

Assign the ticket to a new agent, or null to make the ticket unassigned. This method should run any business rules associated with the assignment change. This method should also guarantee that it won't have the side effect of storing any other changes to the ticket and should throw an exception if the ticket has been otherwise updated.

Specified by:

assignTicketToAgent in interface TicketUpdateStrategy

Parameters:

ticket - The ticket to update the state of

agent - The agent to assign the ticket to or null to mark the ticket as unassigned.

Returns:

CsTicketEventModel

Throws:

TicketException - If the ticket has been modified or the assignment is illegal

preChangeTicketAssignment

protected void preChangeTicketAssignment(CsTicketModel ticket,
                                         EmployeeModel agent)
                                  throws TicketException

Throws:

TicketException

assignTicketToGroup

public CsTicketEventModel assignTicketToGroup(CsTicketModel ticket,
                                              CsAgentGroupModel group)
                                       throws TicketException

Description copied from interface: TicketUpdateStrategy

Assign the ticket to a new group, or null to make the ticket unassigned. This method should run any business rules associated with the assignment change. This method should also guarantee that it won't have the side effect of storing any other changes to the ticket and should throw an exception if the ticket has been otherwise updated.

Specified by:

assignTicketToGroup in interface TicketUpdateStrategy

Parameters:

ticket - The ticket to update the state of

group - The agent group to assign the ticket to or null to mark the ticket as unassigned.

Returns:

CsTicketEventModel

Throws:

TicketException - If the ticket has been modified or the assignment is illegal

preChangeTicketGroup

protected void preChangeTicketGroup(CsTicketModel ticket,
                                    CsAgentGroupModel group)
                             throws TicketException

Throws:

TicketException

createAssignTicketEvent

protected CsTicketEventModel createAssignTicketEvent(CsTicketModel ticket,
                                                     java.util.Set<CsTicketChangeEventEntryModel> changedValues)

createChangeEvent

protected CsTicketEventModel createChangeEvent(CsTicketModel ticket,
                                               java.util.Set<CsTicketChangeEventEntryModel> changedValues)

createChangeEvent

protected CsTicketEventModel createChangeEvent(CsTicketModel ticket,
                                               java.util.Set<CsTicketChangeEventEntryModel> changedValues,
                                               java.lang.String note)

setTicketAttributeChangeEventStrategy

public void setTicketAttributeChangeEventStrategy(TicketAttributeChangeEventStrategy ticketAttributeChangeEventStrategy)

setAvailableNextStates

public void setAvailableNextStates(java.util.Map<CsTicketState,java.util.List<CsTicketState>> availableNextStates)

setTicketEventFactory

public void setTicketEventFactory(TicketEventFactory ticketEventFactory)

setTicketChangeEventType

public void setTicketChangeEventType(java.lang.String ticketChangeEventType)

getContext

protected ItemModelContextImpl getContext(AbstractItemModel model)

getTicketAssigndEventType

public java.lang.String getTicketAssigndEventType()

setTicketAssigndEventType

public void setTicketAssigndEventType(java.lang.String ticketAssigndEventType)

getModelService

protected ModelService getModelService()

setModelService

public void setModelService(ModelService modelService)