using System.Collections.Generic;

namespace Neo.Afx.ViewModels
{
    ///<summary>
    /// Base workflow console viewModel
    ///</summary>
    public class WorkflowConsoleViewModelBase
    {
        /// <summary>
        /// The name of the controller to be used on completion of all for workflow actions as ewll as on the console back button click
        /// </summary>
        public string DashboardControllerName
        {
            get;
            set;
        }

        /// <summary>
        /// The name of the controller to be used for workflow actions. Usually Workflows.FriendlyName
        /// </summary>
        public string ControllerName
        {
            get;
            set;
        }

        /// <summary>
        /// The logged in user's id
        /// </summary>
        public long UserID
        {
            get;
            set;
        }

        /// <summary>
        /// The logged in user's roles
        /// </summary>
        public IEnumerable<int> UserRoles
        {
            get;
            set;
        }

        /// <summary>
        /// Indicates whether a user is an administrator
        /// </summary>
        public bool UserIsAdmin
        {
            get;
            set;
        }

        /// <summary>
        /// The System.Entities EntityID for the data record the workflow instance relates to
        /// </summary>
        public long EntityID
        {
            get;
            set;
        }

        /// <summary>
        /// The System.Entities Primary key value for the related entity
        /// </summary>
        public string EntityKey
        {
            get;
            set;
        }

        /// <summary>
        /// The actual item i.e. record id for the data records the workflow instance relates to
        /// </summary>
        public long ItemID
        {
            get;
            set;
        }

        /// <summary>
        /// The Workflows.WorkflowID
        /// </summary>
        public long WorkflowID
        {
            get;
            set;
        }

        /// <summary>
        /// The WorkflowTemplates.DocumentStoreLocationID
        /// </summary>
        public long DocumentStoreLocationID
        {
            get;
            set;
        }

        /// <summary>
        /// The Workflows.FriendlyName
        /// </summary>
        public string WorkflowFriendlyName
        {
            get;
            set;
        }

        /// <summary>
        /// The workflow template to be used for the workflow
        /// </summary>
        public object WorkflowTemplate
        {
            get;
            set;
        }

        /// <summary>
        /// List of workflow template defaults
        /// </summary>
        public object WorkflowTemplateDefaults
        {
            get;
            set;
        }

        /// <summary>
        /// The actual workflow instance record with steps and tasks
        /// </summary>
        public object WorkflowInstance
        {
            get;
            set;
        }

        /// <summary>
        /// The workflow instance route object
        /// </summary>
        public object WorkflowInstanceRoute
        {
            get;
            set;
        }

        /// <summary>
        /// List of all checklist results as sourced from Form.ChecklistResults
        /// </summary>
        public object FormChecklistResults
        {
            get;
            set;
        }

        /// <summary>
        /// The full entity framework object for the data record 
        /// </summary>
        public object Value
        {
            get;
            set;
        }

        /// <summary>
        /// A list of LookupLists
        /// </summary>
        public object Lookups
        {
            get;
            set;
        }

        /// <summary>
        /// Properties to be used on the UI
        /// </summary>
        public WorkflowConsoleUIProperties Ui
        {
            get;
            set;
        }
    }

    /// <summary>
    /// Defines a lookup list
    /// </summary>
    public class LookupList
    {
        /// <summary>
        /// Default lookup list constructor
        /// </summary>
        /// <param name="listName">What you would like to reference your list as on the client side</param>
        /// <param name="list">The actual list object</param>
        public LookupList(string listName, object list)
        {
            ListName = listName;
            List = list;
        }

        /// <summary>
        /// The list name
        /// </summary>
        public string ListName
        {
            get;
            set;
        }

        /// <summary>
        /// The actual list
        /// </summary>
        public object List
        {
            get;
            set;
        }

    }

    /// <summary>
    /// Properties to be used on the UI
    /// </summary>
    public class WorkflowConsoleUIProperties
    {
        /// <summary>
        /// Indicates whether a user can view the workflow form
        /// </summary>
        public bool canViewForm
        {
            get;
            set;
        }

        /// <summary>
        /// Indicates whether a user can save a record
        /// </summary>
        public bool canSave
        {
            get;
            set;
        }

        /// <summary>
        /// Indicates whether a user can delete a record
        /// </summary>
        public bool canDelete
        {
            get;
            set;
        }

        /// <summary>
        /// Indicates whether a user can print a record
        /// </summary>
        public bool canPrint
        {
            get;
            set;
        }

        /// <summary>
        /// Indicates whether a user can submit a workflow
        /// </summary>
        public bool canSubmit
        {
            get;
            set;
        }

        /// <summary>
        /// Indicates whether a user can approve or reject a workflow
        /// </summary>
        public bool canApproveReject
        {
            get;
            set;
        }

        /// <summary>
        /// Indicates whether a user can approve only
        /// </summary>
        public bool canApprove
        {
            get;
            set;
        }

        /// <summary>
        /// Indicates whether a user can request correction for a workflow
        /// </summary>
        public bool canRequestCorrection
        {
            get;
            set;
        }

        /// <summary>
        /// Indicates whether a user can escalate a workflow
        /// </summary>
        public bool canEscalate
        {
            get;
            set;
        }

        /// <summary>
        /// Indicates whether a user can send an escalation task back to the originating user
        /// </summary>
        public bool canSendEscalationBack
        {
            get;
            set;
        }

        /// <summary>
        /// Indicates whether a user can add a comment to a record
        /// </summary>
        public bool canAddComment
        {
            get;
            set;
        }

        /// <summary>
        /// Indicates whether a user can upload a document to a record
        /// </summary>
        public bool canUploadDocument
        {
            get;
            set;
        }

        /// <summary>
        /// Indicates whether a user can view documents related to a record
        /// </summary>
        public bool canViewDocuments
        {
            get;
            set;
        }

        /// <summary>
        /// Indicates whether a user can view comments related to a record
        /// </summary>
        public bool canViewComments
        {
            get;
            set;
        }

        /// <summary>
        /// Indicates whether a user can view tasks related to a record
        /// </summary>
        public bool canViewTasks
        {
            get;
            set;
        }

        /// <summary>
        /// Indicates whether a user can reassign tasks related to a record
        /// </summary>
        public bool canReAssignTasks
        {
            get;
            set;
        }

        /// <summary>
        /// Indicates whether a user can view correspondence related to a record
        /// </summary>
        public bool canViewCorrespondence
        {
            get;
            set;
        }

        /// <summary>
        /// Indicates whether a user can view queries related to a record
        /// </summary>
        public bool canViewQueries
        {
            get;
            set;
        }

        /// <summary>
        /// Indicates whether a user can view the route indicator
        /// </summary>
        public bool canViewRouteIndicator
        {
            get;
            set;
        }

    }
}