/*
 *  Copyright 2016 Anyware Services
 *
 *  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 org.ametys.plugins.explorer.tasks;

import java.util.Date;
import java.util.List;

import org.ametys.core.user.UserIdentity;
import org.ametys.plugins.repository.AmetysObject;
import org.ametys.plugins.repository.metadata.RichText;
import org.ametys.runtime.i18n.I18nizableText;

/**
 * Task interface
 */
public interface Task extends AmetysObject
{
    /**
     *  Status of a task
     */
    public enum TaskStatus
    {
        /** Task currently opened */
        OPEN("open", new I18nizableText("plugin.explorer", "PLUGINS_EXPLORER_TASKS_STATUS_OPEN_LABEL")),
        /** Task assigned */
        ASSIGNED("assigned", new I18nizableText("plugin.explorer", "PLUGINS_EXPLORER_TASKS_STATUS_ASSIGNED_LABEL")),
        /** Task in progress */
        IN_PROGRESS("in_progress", new I18nizableText("plugin.explorer", "PLUGINS_EXPLORER_TASKS_STATUS_IN_PROGRESS_LABEL")),
        /** Task ended */
        ENDED("ended", new I18nizableText("plugin.explorer", "PLUGINS_EXPLORER_TASKS_STATUS_ENDED_LABEL"));
        
        private String _value;
        private I18nizableText _label;
        
        private TaskStatus(String value, I18nizableText label)
        {
            this._value = value;
            this._label = label;
        }  
           
        @Override
        public String toString() 
        {
            return _value;
        }
        
        /**
         * label getter
         * @return the task priority label
         */
        public I18nizableText getLabel()
        {
            return this._label;
        }
        
        /**
         * Converts a string to a TaskStatus
         * @param status The status to convert
         * @return The status corresponding to the string or null if unknown
         */
        public static TaskStatus createsFromString(String status)
        {
            for (TaskStatus v : TaskStatus.values())
            {
                if (v.toString().equals(status))
                {
                    return v;
                }
            }
            return null;
        }
    }
    
    /**
     * Priority of a task
     */
    public enum TaskPriority
    {
        /** Low priority */
        LOW("low", new I18nizableText("plugin.explorer", "PLUGINS_EXPLORER_TASKS_PRIORITY_LOW_LABEL")),
        /** Default priority */
        NORMAL("normal", new I18nizableText("plugin.explorer", "PLUGINS_EXPLORER_TASKS_PRIORITY_NORMAL_LABEL")),
        /** Urgent priority */
        URGENT("urgent", new I18nizableText("plugin.explorer", "PLUGINS_EXPLORER_TASKS_PRIORITY_URGENT_LABEL"));
        
        private String _value;
        private I18nizableText _label;
        
        private TaskPriority(String value, I18nizableText label)
        {
            this._value = value;
            this._label = label;
        }  
           
        @Override
        public String toString() 
        {
            return _value;
        }
        
        /**
         * label getter
         * @return the task priority label
         */
        public I18nizableText getLabel()
        {
            return this._label;
        }

        /**
         * Converts a string to a TaskPriority
         * @param priority The priority to convert
         * @return The priority corresponding to the string or null if unknown
         */
        public static TaskPriority createsFromString(String priority)
        {
            for (TaskPriority v : TaskPriority.values())
            {
                if (v.toString().equals(priority))
                {
                    return v;
                }
            }
            return null;
        }
    }
    
    /**
     * The identifier of a task
     * @return The id
     */
    public String getTaskId();
    
    /**
     * The title of the task
     * @return The title
     */
    public String getLabel();
    
    /**
     * The description of the task
     * @return The description
     */
    public RichText getDescription();
    
    /**
     * The starting date of the task
     * @return The start date
     */
    public Date getStartDate();
    
    /**
     * The ending date of the task
     * @return The end date
     */
    public Date getEndDate();
    
    /**
     * The status of the task
     * @return The status
     */
    public TaskStatus getStatus();
    
    /**
     * Get the task priority
     * @return the priority
     */
    public TaskPriority getPriority();
    
    /**
     * Get the initial load estimated for this task
     * @return The initial load
     */
    public Double getInitialLoad();
    
    /**
     * Get the progress of the task
     * @return The progress, in percentage
     */
    public Double getProgress();
    
    /**
     * Get the creator of the task
     * @return the creator
     */
    public UserIdentity getAuthor();
    
    /**
     * Get the list of user assigned to this task
     * @return The assignment list
     */
    public List<UserIdentity> getAssignment();
    
    /**
     * Get the list of user subscribed to this task
     * @return The list of subscribers
     */
    public List<UserIdentity> getSubscribers();
    
    /**
     * Get the post's creation date.
     * @return the post's creation date.
     */
    public Date getCreationDate();
    
    /**
     * Get the post's last modification date.
     * @return the post's last modification date.
     */
    public Date getLastModified();
}