/*
    * Copyright 2012-2013 smartics, Kronseder & Reiner GmbH
    *
    * Licensed under the Apache License, Version 2.0 (the "License");
    * you may not use this file except in compliance with the License.
    * You may obtain a copy of the License at
    *
    *     http://www.apache.org/licenses/LICENSE-2.0
    *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  package de.smartics.maven.bugzilla.command;
  
  import java.util.ArrayList;
  import java.util.List;
  
  import de.smartics.maven.issue.command.AbstractCommand;
  import de.smartics.maven.issue.command.AddMilestoneCommand;
  import de.smartics.maven.issue.command.CommandArgument;
  import de.smartics.maven.issue.command.CommandResult.Page;
  
  /**
   * Implementation of the {@link AddMilestoneCommand} for Bugzilla.
   */
  public final class BugzillaAddMilestoneCommand extends
      AbstractCommand<AddMilestoneCommand> implements AddMilestoneCommand
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    /**
     * The class version identifier.
     * <p>
     * The value of this constant is {@value}.
     * </p>
     */
    private static final long serialVersionUID = 1L;
  
    /**
     * The service on the command target to call.
     * <p>
     * The value of this constant is {@value}.
     * </p>
     */
    private static final String SERVICE = "editmilestones.cgi";
  
    /**
     * The title of the expected page if the milestone has been created.
     * <p>
     * The value of this constant is {@value}.
     * </p>
     */
    private static final String EXPECTED_PAGE_TITLE_CREATED = "Milestone Created";
  
    /**
     * The title of the expected page if the milestone already existed.
     * <p>
     * The value of this constant is {@value}.
     * </p>
     */
    private static final String EXPECTED_PAGE_TITLE_EXISTS =
        "Milestone Already Exists";
  
    // --- members --------------------------------------------------------------
  
    // ****************************** Initializer *******************************
  
    // ****************************** Constructors ******************************
  
    /**
     * Default constructor.
     *
     * @param product the product to add the version to.
     * @param milestone the milestone to add.
     * @param sortkey the sort key to the milestone.
     * @param token the token from the previous command to help the browser to
     *          secure the request.
     */
    public BugzillaAddMilestoneCommand(
        // NOPMD
        final CommandArgument<AddMilestoneCommand> product,
        final CommandArgument<AddMilestoneCommand> milestone,
        final CommandArgument<AddMilestoneCommand> sortkey,
        final CommandArgument<AddMilestoneCommand> token)
    {
      super(SERVICE, attachDefaulArguments(product, milestone, sortkey, token));
    }
  
    // ****************************** Inner Classes *****************************
  
    // ********************************* Methods ********************************
  
    // --- init -----------------------------------------------------------------
  
   private static List<CommandArgument<AddMilestoneCommand>> attachDefaulArguments(
       final CommandArgument<AddMilestoneCommand> product,
       final CommandArgument<AddMilestoneCommand> milestone,
       final CommandArgument<AddMilestoneCommand> sortkey,
       final CommandArgument<AddMilestoneCommand> token)
   {
     final List<CommandArgument<AddMilestoneCommand>> allArguments =
         new ArrayList<CommandArgument<AddMilestoneCommand>>(3);
     final CommandArgument<AddMilestoneCommand> action =
         CommandArgument.create(AddMilestoneCommand.Parameter.ACTION, "new");
     allArguments.add(action);
     allArguments.add(product);
     allArguments.add(milestone);
     if (sortkey.hasValue())
     {
       allArguments.add(sortkey);
     }
     allArguments.add(token);
     return allArguments;
   }
 
   // --- get&set --------------------------------------------------------------
 
   // --- business -------------------------------------------------------------
 
   /**
    * {@inheritDoc}
    *
    * @see de.smartics.maven.issue.command.AbstractCommand#checkExpectation(de.smartics.maven.issue.command.CommandResult.Page)
    */
   @Override
   protected Expectation checkExpectation(final Page page)
   {
     final Expectation expectation =
         BugzillaCommandUtils.createExpectation(page,
             EXPECTED_PAGE_TITLE_CREATED, EXPECTED_PAGE_TITLE_EXISTS);
     return expectation;
   }
 
   /**
    * {@inheritDoc}
    *
    * @see de.smartics.maven.issue.command.AbstractCommand#getCommandResultDescription(Page,Expectation)
    */
   @Override
   protected String getCommandResultDescription(final Page page,
       final Expectation expectation)
   {
     final CommandArgument<AddMilestoneCommand> milestoneArg =
         getArgument(AddMilestoneCommand.Parameter.MILESTONE);
     final String expectationFlag = expectation.getFlag();
 
     final String messageSuffix;
     if (EXPECTED_PAGE_TITLE_CREATED.equals(expectationFlag))
     {
       messageSuffix = "has been created.";
     }
     else if (EXPECTED_PAGE_TITLE_EXISTS.equals(expectationFlag))
     {
       messageSuffix = "already existed.";
     }
     else
     {
       messageSuffix = "failed to be created.";
     }
 
     return "Milestone '" + milestoneArg.getValue() + "' " + messageSuffix;
   }
 
   // --- object basics --------------------------------------------------------
 
 }