ActionI18nTitleFormatterImpl.java

/**
 * ESUP-Portail Helpdesk - Copyright (c) 2004-2009 ESUP-Portail consortium.
 */
package org.esupportail.helpdesk.domain; 

import java.util.Locale;

import org.esupportail.commons.services.i18n.I18nService;
import org.esupportail.commons.utils.Assert;
import org.esupportail.helpdesk.domain.beans.Action;
import org.esupportail.helpdesk.domain.userFormatting.UserFormattingService;
import org.esupportail.helpdesk.web.beans.OriginI18nKeyProvider;
import org.esupportail.helpdesk.web.beans.PriorityI18nKeyProvider;
import org.esupportail.helpdesk.web.beans.TicketScopeI18nKeyProvider;
import org.springframework.beans.factory.InitializingBean;

/** 
 * A basic implementation of ActionI18nTitleFormatter.
 */ 
public class ActionI18nTitleFormatterImpl 
implements ActionI18nTitleFormatter, InitializingBean {
	
	/**
	 * The serialization id.
	 */
	private static final long serialVersionUID = -4363781891936383875L;

	/**
	 * The i18n prefix.
	 */
	private static final String PREFIX = "ACTION_TITLE.";
	
	/**
	 * The i18n service.
	 */
	private I18nService i18nService;
	
	/**
	 * The user formatting service.
	 */
	private UserFormattingService userFormattingService;
	
	/**
	 * Bean constructor.
	 */
	public ActionI18nTitleFormatterImpl() {
		super();
	}

	/**
	 * @see org.springframework.beans.factory.InitializingBean#afterPropertiesSet()
	 */
	@Override
	public void afterPropertiesSet() {
		Assert.notNull(this.i18nService, 
				"property i18nService of class " + this.getClass().getName() 
				+ " can not be null");
		Assert.notNull(this.userFormattingService, 
				"property userFormattingService of class " + this.getClass().getName() 
				+ " can not be null");
	}

	/**
	 * @param action 
	 * @param locale 
	 * @return the i18n title of an action. 
	 */
	protected String getActionTitleApproveClosure(final Action action, final Locale locale) {
		return i18nService.getString(PREFIX + "APPROVE", locale, new Object [] {
				action.getDate(),
				userFormattingService.format(action.getUser(), locale),
		});
	}

	/**
	 * @param action 
	 * @param locale 
	 * @return the i18n title of an action. 
	 */
	protected String getActionTitleAssign(final Action action, final Locale locale) {
		if (action.getUser() != null) {
			if (action.getManagerBefore() != null) {
				return i18nService.getString(PREFIX + "ASSIGN", locale, new Object [] {
						action.getDate(),
						userFormattingService.format(action.getUser(), locale),
						userFormattingService.format(action.getManagerAfter(), locale),
						userFormattingService.format(action.getManagerBefore(), locale),
				});
			}
			return i18nService.getString(PREFIX + "ASSIGN_FREE_BEFORE", locale, new Object [] {
					action.getDate(),
					userFormattingService.format(action.getUser(), locale),
					userFormattingService.format(action.getManagerAfter(), locale),
			});
		}
		if (action.getManagerBefore() != null) {
			return i18nService.getString(PREFIX + "ASSIGN_APPLICATION", locale, new Object [] {
					action.getDate(),
					userFormattingService.format(action.getManagerAfter(), locale),
					userFormattingService.format(action.getManagerBefore(), locale),
			});
		}
		return i18nService.getString(PREFIX + "ASSIGN_APPLICATION_FREE_BEFORE", locale, new Object [] {
				action.getDate(),
				userFormattingService.format(action.getManagerAfter(), locale),
		});
	}

	/**
	 * @param action 
	 * @param locale 
	 * @return the i18n title of an action. 
	 */
	protected String getActionTitleCancel(final Action action, final Locale locale) {
		return i18nService.getString(PREFIX + "CANCEL", locale, new Object [] {
				action.getDate(),
				userFormattingService.format(action.getUser(), locale),
		});
	}

	/**
	 * @param action 
	 * @param locale 
	 * @return the i18n title of an action. 
	 */
	protected String getActionTitleCancelPostponement(final Action action, final Locale locale) {
		if (action.getUser() != null) {
			return i18nService.getString(PREFIX + "CANCEL_POSTPONEMENT", locale, new Object [] {
					action.getDate(),
					userFormattingService.format(action.getUser(), locale),
			});
		}
		return i18nService.getString(PREFIX + "CANCEL_POSTPONEMENT_APPLICATION", locale, new Object [] {
				action.getDate(),
		});
	}

	/**
	 * @param action 
	 * @param locale 
	 * @return the i18n title of an action. 
	 */
	protected String getActionTitleChangeCategory(final Action action, final Locale locale) {
		if (action.getUser() != null) {
			if (action.getCategoryAfter() != null && action.getCategoryBefore() != null) {
				return i18nService.getString(PREFIX + "CHANGE_CATEGORY", locale, new Object [] {
						action.getDate(),
						userFormattingService.format(action.getUser(), locale),
						action.getCategoryAfter().getLabel(),
						action.getCategoryBefore().getLabel(),
				});
			}
			if (action.getCategoryAfter() != null) {
				return i18nService.getString(PREFIX + "CHANGE_CATEGORY_FROM_NONE", 
						locale, new Object [] {
						action.getDate(),
						userFormattingService.format(action.getUser(), locale),
						action.getCategoryAfter().getLabel(),
				});
			}
			return i18nService.getString(PREFIX + "CHANGE_CATEGORY_TO_NONE", locale, new Object [] {
					action.getDate(),
					userFormattingService.format(action.getUser(), locale),
			});
		}
		if (action.getCategoryAfter() != null && action.getCategoryBefore() != null) {
			return i18nService.getString(PREFIX + "CHANGE_CATEGORY_APPLICATION", locale, new Object [] {
					action.getDate(),
					action.getCategoryAfter().getLabel(),
					action.getCategoryBefore().getLabel(),
			});
		}
		if (action.getCategoryAfter() != null) {
			return i18nService.getString(PREFIX + "CHANGE_CATEGORY_APPLICATION_FROM_NONE", 
					locale, new Object [] {
					action.getDate(),
					action.getCategoryAfter().getLabel(),
			});
		}
		return i18nService.getString(PREFIX + "CHANGE_CATEGORY_APPLICATION_TO_NONE", locale, new Object [] {
				action.getDate(),
		});
	}

	/**
	 * @param action 
	 * @param locale 
	 * @return the i18n title of an action. 
	 */
	protected String getActionTitleChangeComputer(final Action action, final Locale locale) {
		if (action.getComputerAfter() == null) {
			return i18nService.getString(PREFIX + "CHANGE_COMPUTER_NULL_AFTER", locale, new Object [] {
					action.getDate(),
					userFormattingService.format(action.getUser(), locale),
					action.getComputerBefore(),
			});
		}
		if (action.getComputerBefore() == null) {
			return i18nService.getString(PREFIX + "CHANGE_COMPUTER_NULL_BEFORE", locale, new Object [] {
					action.getDate(),
					userFormattingService.format(action.getUser(), locale),
					action.getComputerAfter(),
			});
		}
		return i18nService.getString(PREFIX + "CHANGE_COMPUTER", locale, new Object [] {
				action.getDate(),
				userFormattingService.format(action.getUser(), locale),
				action.getComputerAfter(),
				action.getComputerBefore(),
		});
	}

	/**
	 * @param action 
	 * @param locale 
	 * @return the i18n title of an action. 
	 */
	protected String getActionTitleChangeDepartment(final Action action, final Locale locale) {
		if (action.getUser() != null) {
			if (action.getDepartmentAfter() != null && action.getDepartmentBefore() != null) {
				return i18nService.getString(PREFIX + "CHANGE_DEPARTMENT", locale, new Object [] {
						action.getDate(),
						userFormattingService.format(action.getUser(), locale),
						action.getDepartmentAfter().getLabel(),
						action.getDepartmentBefore().getLabel(),
				});
			}
			if (action.getDepartmentAfter() != null && action.getDepartmentBefore() != null) {
				return i18nService.getString(PREFIX + "CHANGE_DEPARTMENT_FROM_NONE", 
						locale, new Object [] {
						action.getDate(),
						userFormattingService.format(action.getUser(), locale),
						action.getDepartmentAfter().getLabel(),
				});
			}
			return i18nService.getString(PREFIX + "CHANGE_DEPARTMENT_TO_NONE", 
					locale, new Object [] {
					action.getDate(),
					userFormattingService.format(action.getUser(), locale),
			});
		}
		if (action.getDepartmentAfter() != null && action.getDepartmentBefore() != null) {
			return i18nService.getString(PREFIX + "CHANGE_DEPARTMENT_APPLICATION", 
					locale, new Object [] {
					action.getDate(),
					action.getDepartmentAfter().getLabel(),
					action.getDepartmentBefore().getLabel(),
			});
		}
		if (action.getDepartmentAfter() != null && action.getDepartmentBefore() != null) {
			return i18nService.getString(PREFIX + "CHANGE_DEPARTMENT_APPLICATION_FROM_NONE", 
					locale, new Object [] {
					action.getDate(),
					action.getDepartmentAfter().getLabel(),
			});
		}
		return i18nService.getString(PREFIX + "CHANGE_DEPARTMENT_APPLICATION_TO_NONE", 
				locale, new Object [] {
				action.getDate(),
		});
	}

	/**
	 * @param action 
	 * @param locale 
	 * @return the i18n title of an action. 
	 */
	protected String getActionTitleChangeLabel(final Action action, final Locale locale) {
		return i18nService.getString(PREFIX + "CHANGE_LABEL", locale, new Object [] {
				action.getDate(),
				userFormattingService.format(action.getUser(), locale),
				action.getLabelAfter(),
				action.getLabelBefore(),
		});
	}

	/**
	 * @param action 
	 * @param locale 
	 * @return the i18n title of an action. 
	 */
	protected String getActionTitleChangeOrigin(final Action action, final Locale locale) {
		return i18nService.getString(PREFIX + "CHANGE_ORIGIN", locale, new Object [] {
				action.getDate(),
				userFormattingService.format(action.getUser(), locale),
				i18nService.getString(
						OriginI18nKeyProvider.getI18nKey(action.getOriginAfter()), 
						locale),
				i18nService.getString(
						OriginI18nKeyProvider.getI18nKey(action.getOriginBefore()), 
						locale),
		});
	}

	/**
	 * @param action 
	 * @param locale 
	 * @return the i18n title of an action. 
	 */
	protected String getActionTitleChangeOwner(final Action action, final Locale locale) {
		if (action.getUser() != null) {
			return i18nService.getString(PREFIX + "CHANGE_OWNER", locale, new Object [] {
					action.getDate(),
					userFormattingService.format(action.getUser(), locale),
					userFormattingService.format(action.getTicketOwnerAfter(), locale),
					userFormattingService.format(action.getTicketOwnerBefore(), locale),
			});
		}
		return i18nService.getString(PREFIX + "CHANGE_OWNER_APPLICATION", locale, new Object [] {
				action.getDate(),
				userFormattingService.format(action.getTicketOwnerAfter(), locale),
				userFormattingService.format(action.getTicketOwnerBefore(), locale),
		});
	}

	/**
	 * @param action 
	 * @param locale 
	 * @return the i18n title of an action. 
	 */
	protected String getActionTitleChangePriority(final Action action, final Locale locale) {
		return i18nService.getString(PREFIX + "CHANGE_PRIORITY", locale, new Object [] {
				action.getDate(),
				userFormattingService.format(action.getUser(), locale),
				i18nService.getString(
						PriorityI18nKeyProvider.getI18nKey(action.getPriorityLevelAfter()), 
						locale),
				i18nService.getString(
						PriorityI18nKeyProvider.getI18nKey(action.getPriorityLevelBefore()), 
						locale),
		});
	}

	/**
	 * @param action 
	 * @param locale 
	 * @return the i18n title of an action. 
	 */
	protected String getActionTitleChangeScope(final Action action, final Locale locale) {
		return i18nService.getString(PREFIX + "CHANGE_SCOPE", locale, new Object [] {
				action.getDate(),
				userFormattingService.format(action.getUser(), locale),
				i18nService.getString(TicketScopeI18nKeyProvider.getI18nKey(action.getScopeAfter()), 
						locale),
				i18nService.getString(TicketScopeI18nKeyProvider.getI18nKey(action.getScopeBefore()), 
						locale),
		});
	}

	/**
	 * @param action 
	 * @param locale 
	 * @return the i18n title of an action. 
	 */
	protected String getActionTitleChangeSpentTime(final Action action, final Locale locale) {
		return i18nService.getString(PREFIX + "CHANGE_SPENT_TIME", locale, new Object [] {
				action.getDate(),
				userFormattingService.format(action.getUser(), locale),
		});
	}
	
	/**
	 * @param action 
	 * @param locale 
	 * @return the i18n title of an action. 
	 */
	protected String getActionTitleClose(final Action action, final Locale locale) {
		return i18nService.getString(PREFIX + "CLOSE", locale, new Object [] {
				action.getDate(),
				userFormattingService.format(action.getUser(), locale),
		});
	}

	/**
	 * @param action 
	 * @param locale 
	 * @return the i18n title of an action. 
	 */
	protected String getActionTitleCreate(final Action action, final Locale locale) {
		return i18nService.getString(PREFIX + "CREATE", locale, new Object [] {
				action.getDate(),
				userFormattingService.format(action.getUser(), locale),
		});
	}

	/**
	 * @param action 
	 * @param locale 
	 * @return the i18n title of an action. 
	 */
	protected String getActionTitleExpire(final Action action, final Locale locale) {
		return i18nService.getString(PREFIX + "EXPIRE", locale, new Object [] {
				action.getDate(),
		});
	}

	/**
	 * @param action 
	 * @param locale 
	 * @return the i18n title of an action. 
	 */
	protected String getActionTitleFree(final Action action, final Locale locale) {
		if (action.getUser() != null) {
			return i18nService.getString(PREFIX + "FREE", locale, new Object [] {
					action.getDate(),
					userFormattingService.format(action.getUser(), locale),
					userFormattingService.format(action.getManagerBefore(), locale),
			});
		}
		return i18nService.getString(PREFIX + "FREE_APPLICATION", locale, new Object [] {
				action.getDate(),
				userFormattingService.format(action.getManagerBefore(), locale),
		});
	}

	/**
	 * @param action 
	 * @param locale 
	 * @return the i18n title of an action. 
	 */
	protected String getActionTitleGiveInformation(final Action action, final Locale locale) {
		if (action.getUser() != null) {
			return i18nService.getString(PREFIX + "GIVE_INFORMATION", locale, new Object [] {
					action.getDate(),
					userFormattingService.format(action.getUser(), locale),
			});
		}
		return i18nService.getString(PREFIX + "GIVE_INFORMATION_APPLICATION", locale, new Object [] {
				action.getDate(),
		});
	}

	/**
	 * @param action 
	 * @param locale 
	 * @return the i18n title of an action. 
	 */
	protected String getActionTitleInvite(final Action action, final Locale locale) {
		if (action.getUser() == null) {
			return i18nService.getString(PREFIX + "INVITE_APPLICATION", locale, new Object [] {
					action.getDate(),
					userFormattingService.format(action.getInvitedUser(), locale),
			});
		}
		if (action.getUser().equals(action.getInvitedUser())) {
			return i18nService.getString(PREFIX + "INVITE_SELF", locale, new Object [] {
					action.getDate(),
					userFormattingService.format(action.getUser(), locale),
			});
		}
		return i18nService.getString(PREFIX + "INVITE", locale, new Object [] {
				action.getDate(),
				userFormattingService.format(action.getUser(), locale),
				userFormattingService.format(action.getInvitedUser(), locale),
		});
	}

	/**
	 * @param action 
	 * @param locale 
	 * @return the i18n title of an action. 
	 */
	protected String getActionTitleMonitoringInviteV2(final Action action, final Locale locale) {
		return i18nService.getString(PREFIX + "MONITORING_INVITE_V2", locale, new Object [] {
				action.getDate(),
				userFormattingService.format(action.getUser(), locale),
				userFormattingService.format(action.getInvitedUser(), locale),
		});
	}

	/**
	 * @param action 
	 * @param locale 
	 * @return the i18n title of an action. 
	 */
	protected String getActionTitleRemoveInvitation(final Action action, final Locale locale) {
		if (action.getUser() == null) {
			return i18nService.getString(PREFIX + "REMOVE_INVITATION_APPLICATION", locale, new Object [] {
					action.getDate(),
					userFormattingService.format(action.getInvitedUser(), locale),
			});
		}
		if (action.getUser().equals(action.getInvitedUser())) {
			return i18nService.getString(PREFIX + "REMOVE_INVITATION_SELF", locale, new Object [] {
					action.getDate(),
					userFormattingService.format(action.getUser(), locale),
			});
		}
		return i18nService.getString(PREFIX + "REMOVE_INVITATION", locale, new Object [] {
				action.getDate(),
				userFormattingService.format(action.getUser(), locale),
				userFormattingService.format(action.getInvitedUser(), locale),
		});
	}

	/**
	 * @param action 
	 * @param locale 
	 * @return the i18n title of an action. 
	 */
	protected String getActionTitlePostpone(final Action action, final Locale locale) {
		return i18nService.getString(PREFIX + "POSTPONE", locale, new Object [] {
				action.getDate(),
				userFormattingService.format(action.getUser(), locale),
		});
	}

	/**
	 * @param action 
	 * @param locale 
	 * @return the i18n title of an action. 
	 */
	protected String getActionTitleRefuse(final Action action, final Locale locale) {
		return i18nService.getString(PREFIX + "REFUSE", locale, new Object [] {
				action.getDate(),
				userFormattingService.format(action.getUser(), locale),
		});
	}

	/**
	 * @param action 
	 * @param locale 
	 * @return the i18n title of an action. 
	 */
	protected String getActionTitleRefuseClosure(final Action action, final Locale locale) {
		return i18nService.getString(PREFIX + "REFUSE_CLOSURE", locale, new Object [] {
				action.getDate(),
				userFormattingService.format(action.getUser(), locale),
		});
	}

	/**
	 * @param action 
	 * @param locale 
	 * @return the i18n title of an action. 
	 */
	protected String getActionTitleReopen(final Action action, final Locale locale) {
		return i18nService.getString(PREFIX + "REOPEN", locale, new Object [] {
				action.getDate(),
				userFormattingService.format(action.getUser(), locale),
		});
	}

	/**
	 * @param action 
	 * @param locale 
	 * @return the i18n title of an action. 
	 */
	protected String getActionTitleRequestInformation(final Action action, final Locale locale) {
		return i18nService.getString(PREFIX + "REQUEST_INFORMATION", locale, new Object [] {
				action.getDate(),
				userFormattingService.format(action.getUser(), locale),
		});
	}

	/**
	 * @param action 
	 * @param locale 
	 * @return the i18n title of an action. 
	 */
	protected String getActionTitleTake(final Action action, final Locale locale) {
		if (action.getManagerBefore() != null) {
			return i18nService.getString(PREFIX + "TAKE", locale, new Object [] {
					action.getDate(),
					userFormattingService.format(action.getUser(), locale),
					userFormattingService.format(action.getManagerBefore(), locale),
			});
		}
		return i18nService.getString(PREFIX + "TAKE_FREE_BEFORE", locale, new Object [] {
				action.getDate(),
				userFormattingService.format(action.getUser(), locale),
		});
	}

	/**
	 * @param action 
	 * @param locale 
	 * @return the i18n title of an action. 
	 */
	protected String getActionTitleUpload(final Action action, final Locale locale) {
		if (action.getUser() != null) {
			return i18nService.getString(PREFIX + "UPLOAD", locale, new Object [] {
					action.getDate(),
					userFormattingService.format(action.getUser(), locale),
					action.getFilename(),
			});
		}
		return i18nService.getString(PREFIX + "UPLOAD_APPLICATION", locale, new Object [] {
				action.getDate(),
				action.getFilename(),
		});
	}

	/**
	 * @see org.esupportail.helpdesk.domain.ActionI18nTitleFormatter#getActionTitle(
	 * org.esupportail.helpdesk.domain.beans.Action, java.util.Locale)
	 */
	@Override
	public String getActionTitle(final Action action, final Locale locale) {
		if (ActionType.APPROVE_CLOSURE.equals(action.getActionType())) {
			return getActionTitleApproveClosure(action, locale);
		}
		if (ActionType.ASSIGN.equals(action.getActionType())) {
			return getActionTitleAssign(action, locale);
		}
		if (ActionType.CANCEL.equals(action.getActionType())) {
			return getActionTitleCancel(action, locale);
		}
		if (ActionType.CANCEL_POSTPONEMENT.equals(action.getActionType())) {
			return getActionTitleCancelPostponement(action, locale);
		}
		if (ActionType.CHANGE_CATEGORY.equals(action.getActionType())) {
			return getActionTitleChangeCategory(action, locale);
		}
		if (ActionType.CHANGE_COMPUTER.equals(action.getActionType())) {
			return getActionTitleChangeComputer(action, locale);
		}
		if (ActionType.CHANGE_DEPARTMENT.equals(action.getActionType())) {
			return getActionTitleChangeDepartment(action, locale);
		}
		if (ActionType.CHANGE_LABEL.equals(action.getActionType())) {
			return getActionTitleChangeLabel(action, locale);
		}
		if (ActionType.CHANGE_ORIGIN.equals(action.getActionType())) {
			return getActionTitleChangeOrigin(action, locale);
		}
		if (ActionType.CHANGE_OWNER.equals(action.getActionType())) {
			return getActionTitleChangeOwner(action, locale);
		}
		if (ActionType.CHANGE_PRIORITY.equals(action.getActionType())) {
			return getActionTitleChangePriority(action, locale);
		}
		if (ActionType.CHANGE_SCOPE.equals(action.getActionType())) {
			return getActionTitleChangeScope(action, locale);
		}
		if (ActionType.CHANGE_SPENT_TIME.equals(action.getActionType())) {
			return getActionTitleChangeSpentTime(action, locale);
		}
		if (ActionType.CLOSE.equals(action.getActionType()) 
				|| ActionType.CLOSE_APPROVE.equals(action.getActionType())) {
			return getActionTitleClose(action, locale);
		}
		if (ActionType.CREATE.equals(action.getActionType())) {
			return getActionTitleCreate(action, locale);
		}
		if (ActionType.EXPIRE.equals(action.getActionType())) {
			return getActionTitleExpire(action, locale);
		}
		if (ActionType.FREE.equals(action.getActionType())) {
			return getActionTitleFree(action, locale);
		}
		if (ActionType.GIVE_INFORMATION.equals(action.getActionType())) {
			return getActionTitleGiveInformation(action, locale);
		}
		if (ActionType.INVITE.equals(action.getActionType())) {
			return getActionTitleInvite(action, locale);
		}
		if (ActionType.REMOVE_INVITATION.equals(action.getActionType())) {
			return getActionTitleRemoveInvitation(action, locale);
		}
		if (ActionType.POSTPONE.equals(action.getActionType())) {
			return getActionTitlePostpone(action, locale);
		}
		if (ActionType.REFUSE.equals(action.getActionType())) {
			return getActionTitleRefuse(action, locale);
		}
		if (ActionType.REFUSE_CLOSURE.equals(action.getActionType())) {
			return getActionTitleRefuseClosure(action, locale);
		}
		if (ActionType.REOPEN.equals(action.getActionType())) {
			return getActionTitleReopen(action, locale);
		}
		if (ActionType.REQUEST_INFORMATION.equals(action.getActionType())) {
			return getActionTitleRequestInformation(action, locale);
		}
		if (ActionType.TAKE.equals(action.getActionType())) {
			return getActionTitleTake(action, locale);
		}
		if (ActionType.MONITORING_INVITE_V2.equals(action.getActionType())) {
			return getActionTitleMonitoringInviteV2(action, locale);
		}
		if (ActionType.UPLOAD.equals(action.getActionType())) {
			return getActionTitleUpload(action, locale);
		}
		return "??? " + action.getActionType() + " ???";
	}

	/**
	 * @return the i18nService
	 */
	protected I18nService getI18nService() {
		return i18nService;
	}

	/**
	 * @param service the i18nService to set
	 */
	public void setI18nService(final I18nService service) {
		i18nService = service;
	}

	/**
	 * @return the userFormattingService
	 */
	protected UserFormattingService getUserFormattingService() {
		return userFormattingService;
	}

	/**
	 * @param userFormattingService the userFormattingService to set
	 */
	public void setUserFormattingService(final UserFormattingService userFormattingService) {
		this.userFormattingService = userFormattingService;
	}

}